forked from docs/doc-exports
Ru, Li Yi
52ab2e2398
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com> Co-authored-by: Ru, Li Yi <liyiru7@huawei.com> Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
196 lines
15 KiB
HTML
196 lines
15 KiB
HTML
<a name="UpdateGaussMySqlInstancePort"></a><a name="UpdateGaussMySqlInstancePort"></a>
|
|
|
|
<h1 class="topictitle1">Changing a Database Port</h1>
|
|
<div id="body8662426"><div class="section" id="UpdateGaussMySqlInstancePort__section14838183083615"><h4 class="sectiontitle">Function</h4><p id="UpdateGaussMySqlInstancePort__p683973093617">This API is used to change the database port of a DB instance. Before calling this API:</p>
|
|
<ul id="UpdateGaussMySqlInstancePort__ul924420236520"><li id="UpdateGaussMySqlInstancePort__gaussdb_04_0001_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="UpdateGaussMySqlInstancePort__gaussdb_04_0001_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="UpdateGaussMySqlInstancePort__section1840173013614"><h4 class="sectiontitle">URI</h4><p id="UpdateGaussMySqlInstancePort__p10840123011361">PUT /v3/{project_id}/instances/{instance_id}/port</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateGaussMySqlInstancePort__table158429307364" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="UpdateGaussMySqlInstancePort__row584173010362"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="UpdateGaussMySqlInstancePort__p984243014367">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="UpdateGaussMySqlInstancePort__p118431830173610">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="UpdateGaussMySqlInstancePort__p58437302368">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="UpdateGaussMySqlInstancePort__p28441630113617">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateGaussMySqlInstancePort__row684119301361"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdateGaussMySqlInstancePort__p118441730113612">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdateGaussMySqlInstancePort__p1584423013613">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdateGaussMySqlInstancePort__p17845113043618">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdateGaussMySqlInstancePort__p484583018369">Project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateGaussMySqlInstancePort__row884119302366"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdateGaussMySqlInstancePort__p18469308360">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdateGaussMySqlInstancePort__p1884617303361">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdateGaussMySqlInstancePort__p284720303368">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdateGaussMySqlInstancePort__p1847183063612">Instance ID of a tenant in a project.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateGaussMySqlInstancePort__section17848330193617"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateGaussMySqlInstancePort__en-us_topic_0000001471405273_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="UpdateGaussMySqlInstancePort__row18848330173611"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="UpdateGaussMySqlInstancePort__p1085015307368">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="UpdateGaussMySqlInstancePort__p48511230133617">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="UpdateGaussMySqlInstancePort__p158525305367">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="UpdateGaussMySqlInstancePort__p785243023617">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateGaussMySqlInstancePort__row4849133043611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdateGaussMySqlInstancePort__p11853133023619">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdateGaussMySqlInstancePort__p685313017368">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdateGaussMySqlInstancePort__p28541930163619">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdateGaussMySqlInstancePort__p1685420307369">User token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateGaussMySqlInstancePort__row1084933043618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdateGaussMySqlInstancePort__p10855163012367">X-Language</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdateGaussMySqlInstancePort__p5855183013611">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdateGaussMySqlInstancePort__p18856123011365">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdateGaussMySqlInstancePort__p5856103043610">Language.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateGaussMySqlInstancePort__en-us_topic_0000001471405273_request_ModifyPortRequest" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="UpdateGaussMySqlInstancePort__row185773017366"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateGaussMySqlInstancePort__p168581130153616">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateGaussMySqlInstancePort__p1685817309368">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateGaussMySqlInstancePort__p6859153003617">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateGaussMySqlInstancePort__p1085913018369">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateGaussMySqlInstancePort__row5857183017363"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateGaussMySqlInstancePort__p4860193073619">port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateGaussMySqlInstancePort__p086053013363">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateGaussMySqlInstancePort__p286003016360">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateGaussMySqlInstancePort__p8861230193618">Port number.</p>
|
|
<p id="UpdateGaussMySqlInstancePort__p1886133010368">Value range: 1024 to 65535, excluding 5342 to 5345, 12017, 20000, 20201, 20202, and 33062.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateGaussMySqlInstancePort__section1086273017367"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateGaussMySqlInstancePort__p1486273018368"><strong id="UpdateGaussMySqlInstancePort__b1586318304365">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateGaussMySqlInstancePort__en-us_topic_0000001471405273_response_MysqlJobId" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameter</caption><thead align="left"><tr id="UpdateGaussMySqlInstancePort__row7864330153610"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="UpdateGaussMySqlInstancePort__p986573012361">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="UpdateGaussMySqlInstancePort__p158656307364">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="UpdateGaussMySqlInstancePort__p15868133083617">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateGaussMySqlInstancePort__row186413014362"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdateGaussMySqlInstancePort__p886993011363">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdateGaussMySqlInstancePort__p14869330183618">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdateGaussMySqlInstancePort__p188692307369">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateGaussMySqlInstancePort__p987019301363"><strong id="UpdateGaussMySqlInstancePort__b1487083083619">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateGaussMySqlInstancePort__en-us_topic_0000001471405273_response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameter</caption><thead align="left"><tr id="UpdateGaussMySqlInstancePort__row1187043053617"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="UpdateGaussMySqlInstancePort__p68724301364">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="UpdateGaussMySqlInstancePort__p48723306361">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="UpdateGaussMySqlInstancePort__p17872133017363">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateGaussMySqlInstancePort__row28716303362"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdateGaussMySqlInstancePort__p887316308362">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdateGaussMySqlInstancePort__p1487313307369">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdateGaussMySqlInstancePort__p1587423013620">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateGaussMySqlInstancePort__row9871193015369"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdateGaussMySqlInstancePort__p4874143017366">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdateGaussMySqlInstancePort__p13874430103617">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdateGaussMySqlInstancePort__p1087503018361">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateGaussMySqlInstancePort__p3875430113618"><strong id="UpdateGaussMySqlInstancePort__b48751530103619">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateGaussMySqlInstancePort__table6875173083611" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameter</caption><thead align="left"><tr id="UpdateGaussMySqlInstancePort__row587613303360"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="UpdateGaussMySqlInstancePort__p7877123012363">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="UpdateGaussMySqlInstancePort__p128771130193615">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="UpdateGaussMySqlInstancePort__p1987815302361">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateGaussMySqlInstancePort__row1287616308369"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdateGaussMySqlInstancePort__p1487883063617">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdateGaussMySqlInstancePort__p387993012368">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdateGaussMySqlInstancePort__p58792030113610">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateGaussMySqlInstancePort__row19876130113616"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdateGaussMySqlInstancePort__p4879130153612">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdateGaussMySqlInstancePort__p188808300364">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdateGaussMySqlInstancePort__p19880153023619">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateGaussMySqlInstancePort__section18881103018362"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="UpdateGaussMySqlInstancePort__screen58823302361">PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/port
|
|
|
|
{
|
|
"port" : 8836
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="UpdateGaussMySqlInstancePort__section1388416305368"><h4 class="sectiontitle">Example Response</h4><p id="UpdateGaussMySqlInstancePort__p88851830183610"><strong id="UpdateGaussMySqlInstancePort__b188850308364">Status code: 200</strong></p>
|
|
<p id="UpdateGaussMySqlInstancePort__p888553053615">Success.</p>
|
|
<pre class="screen" id="UpdateGaussMySqlInstancePort__screen2886130173612">{
|
|
"job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="UpdateGaussMySqlInstancePort__section13312155313343"><h4 class="sectiontitle">Status Code</h4><p id="UpdateGaussMySqlInstancePort__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="UpdateGaussMySqlInstancePort__section33212053103415"><h4 class="sectiontitle">Error Code</h4><p id="UpdateGaussMySqlInstancePort__p632225363413">For details, see <a href="gaussdb_10_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_04_0003.html">Managing DB Instances</a></div>
|
|
</div>
|
|
</div>
|
|
|