forked from docs/doc-exports
wangdengke2
823df869a9
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>
146 lines
15 KiB
HTML
146 lines
15 KiB
HTML
<a name="EN-US_TOPIC_0000002217069689"></a><a name="EN-US_TOPIC_0000002217069689"></a>
|
|
|
|
<h1 class="topictitle1">Changing an Instance Port<span id="en-us_topic_0000002177933802_ph1947994118203"> (a V3 API)</span></h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_section3267183415221"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p18204154013583">This API is used to change an instance port.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_section112703340229"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p1284110553585">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_section6279183442210"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p112818349221">PUT /v3/{project_id}/instances/{instance_id}/port</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_table528414342220" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_row1328253411227"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p112853341226"><strong id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_b215268787113952">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p1128723418225"><strong id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_b1247510180113952">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.99%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p1289534182218"><strong id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_b1467193513113952">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.01%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p152901334132211"><strong id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_b968796384113952">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_row1528233412213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p2293193422212">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p9295163412219">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p1129710341221">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.01%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p1629883420226">Project ID of a tenant in a region</p>
|
|
<p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p20468185020243">For how to obtain a project ID, see <a href="ddm_api_01_0063.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_row1428217348222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p7300193432210">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p4302123413222">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p730419346226">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.01%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p430663416227">DDM instance ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_section1630814345229"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002217069689__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_row17750142410125"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_p975132420122"><strong id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_b579113162262">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_p3752122414125"><strong id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_b2823101742611">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_p1975292441214"><strong id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_b17441318172616">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_p975313242120"><strong id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_b075651972615">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_row1875092491217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_p127531824181217">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_p1975412411211">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_p175411241126">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_p127559240125">User token.</p>
|
|
<p id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_p5755162461219">It can be obtained by calling an IAM API. The value of <strong id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_b86806241268">X-Subject-Token</strong> in the response header is the user token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_row15921391494"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_p349830125020">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_p049870145012">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_p249830195014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_p9498602506">MIME type of the request body. Value range:</p>
|
|
<ul id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_ul449830165011"><li id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_li649860115010">application/json</li><li id="EN-US_TOPIC_0000002217069689__ddm_api_01_0020_li1749814013508">application/json;charset=utf-8</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_table83882817577" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_row163884865714"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p1038888165718"><strong id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_b1625345022113952">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p15388158195717"><strong id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_b939859737113952">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p138815865712"><strong id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_b2134193287113952">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p123885817573"><strong id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_b237935421113952">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_row2388080578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p0388108135715">port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p1438810875718">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p1638819875719">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p1338810835717">Port number</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_section12296195852419"><h4 class="sectiontitle">Example Request</h4><div class="p" id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p5316812195612">Changing an instance port to 5067<pre class="screen" id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_screen3467182413569">POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/port
|
|
{
|
|
"port" : 5067
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_section46141034102212"><h4 class="sectiontitle">Response Parameters</h4><ul id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_ul965114419404"><li id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_li565164164016">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_response_UpdateInstanceParametersResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_row176191434132211"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p176224344229"><strong id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_b102189892113952">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p136245348222"><strong id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_b1576294377113952">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p13626634152211"><strong id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_b384957738113952">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_row16191134182211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p156411734122216">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p7643113416226">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p864418348226">Job ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_ul9317162773917"><li id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_li15447111114418">Normal response example<pre class="screen" id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_screen6794163482214">{
|
|
"job_id" : "9fe84a77-6a6b-4b03-9a3e-db910a548657"
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_li15551925175513">Abnormal response<p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p817915438114"><a name="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_li15551925175513"></a><a name="en-us_topic_0000002177933802_li15551925175513"></a>For details, see <a href="ddm_api_01_0059.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_section1692642713119"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_ul4926202781113"><li id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_li2926102711111">Normal<p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p189265276119"><a name="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_li2926102711111"></a><a name="en-us_topic_0000002177933802_li2926102711111"></a>202</p>
|
|
</li><li id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_li1927182719118">Abnormal<p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p792722712111"><a name="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_li1927182719118"></a><a name="en-us_topic_0000002177933802_li1927182719118"></a>For details, see <a href="ddm_api_01_0060.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_section12927142721111"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002217069689__en-us_topic_0000002177933802_p1692752713111">For details, see <a href="ddm_api_01_0061.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="ddm_api_01_0014.html">DDM Instances</a></div>
|
|
</div>
|
|
</div>
|
|
|