lboka/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dc/api-ref/UpdateVirtualGateway.html
Qin Ying, Fan 62ab8a5fe2 DC API 20231101 version 
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2024-03-11 15:10:40 +00:00

388 lines
36 KiB
HTML
Raw Blame History

<a name="UpdateVirtualGateway"></a><a name="UpdateVirtualGateway"></a>
<h1 class="topictitle1">Updating a Virtual Gateway</h1>
<div id="body8662426"><div class="section" id="UpdateVirtualGateway__en-us_topic_0000001735666528_section350412104171"><h4 class="sectiontitle">Function</h4><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p15504151019175">This API is used to update a virtual gateway.</p>
</div>
<div class="section" id="UpdateVirtualGateway__en-us_topic_0000001735666528_section195061910101718"><h4 class="sectiontitle">URI</h4><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p125061510191717">PUT /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateVirtualGateway__en-us_topic_0000001735666528_table20508310191713" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row1250781017170"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p8508210131711">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p35081310191718">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p17509171001714">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p050921011716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row3507161031718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p9510110191719">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p951041018173">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p55111910181718">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p145119101172">Specifies the project ID.</p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row550714105177"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p165121106172">virtual_gateway_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p85121510181713">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1951315103175">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1951318105177">Specifies the virtual gateway ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateVirtualGateway__en-us_topic_0000001735666528_section1551417100173"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateVirtualGateway__en-us_topic_0000001735666528_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row75141910121711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p251571091713">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p151611100172">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p185166102177">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p13517141019171">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row13514151071719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p2517171061714">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p175181410181719">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p3518610111712">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p15519111071715">Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the <em id="UpdateVirtualGateway__en-us_topic_0000001735666528_i45198107171">Identity and Access Management API Reference</em>. The token is the value of <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b16519181031711">X-Subject-Token</strong> in the response header.</p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p8519010111718">Minimum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b551911013173">0</strong></p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p951971011718">Maximum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b1520161017174">10240</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateVirtualGateway__en-us_topic_0000001735666528_request_UpdateVirtualGatewayRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row155201910131717"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p752111103179">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p205221103179">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1352271081711">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p195231310171715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row4520131031720"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p195231010181713">virtual_gateway</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1752461014173">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p14524181020175"><a href="#UpdateVirtualGateway__en-us_topic_0000001735666528_request_UpdateVirtualGateway">UpdateVirtualGateway</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p552521018171">Specifies the virtual gateway to be updated.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdateVirtualGateway__en-us_topic_0000001735666528_request_UpdateVirtualGateway"></a><a name="en-us_topic_0000001735666528_request_UpdateVirtualGateway"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdateVirtualGateway__en-us_topic_0000001735666528_request_UpdateVirtualGateway" frame="border" border="1" rules="all"><caption><b>Table 4 </b>UpdateVirtualGateway</caption><thead align="left"><tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row11525110121716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1952791018171">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p45275106177">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p145288101174">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1452861081715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row19525201017174"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1352991071718">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p5529101015172">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p25292103176">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p953011091715">Specifies the virtual gateway name.</p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p85301910111711">Minimum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b35318104173">0</strong></p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p205311010151711">Maximum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b1253117104177">64</strong></p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row19526201001712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p2531181017171">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p18532191051710">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p753210102172">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p19533201020173">Provides supplementary information about the virtual gateway.</p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p14533161041711">Minimum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b95331710181710">0</strong></p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p16533181011710">Maximum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b1153311081716">128</strong></p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row2526191021716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p8534131011172">local_ep_group</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p16534310151710">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p35351510171713">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1853551041711">Lists the IPv4 subnets that can be accessed over the virtual gateway. Generally, the list contains the subnet CIDR blocks of the associated VPC. The list can be updated only when the virtual gateway is associated with the VPC.</p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1753681021711">Array Length: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b5536111031715">1 - 200</strong></p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row6526101019177"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p12536110201718">local_ep_group_ipv6</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p12537171001718">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p7537310151719">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1053781015175">Lists the IPv6 subnets that can be accessed using the virtual gateway. Usually, the subnets are those in the VPC associated with the virtual gateway. (This is a reserved parameter and is not supported currently.)</p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p7538161021717">Array Length: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b4538191014174">1 - 50</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateVirtualGateway__en-us_topic_0000001735666528_section135381410141718"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p14539181091714"><strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b13539141013176">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateVirtualGateway__en-us_topic_0000001735666528_response_ShowVirtualGatewayResponseBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row553913106176"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p2540191051715">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p654101071718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p154111051717">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row1954061011719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p15542111010176">virtual_gateway</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1254281021712"><a href="#UpdateVirtualGateway__en-us_topic_0000001735666528_response_VirtualGateway">VirtualGateway</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p125437108178">Specifies parameters for creating a virtual gateway.</p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row11540101051716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p254313106177">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p15544710111711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p2544161021720">Specifies the request ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdateVirtualGateway__en-us_topic_0000001735666528_response_VirtualGateway"></a><a name="en-us_topic_0000001735666528_response_VirtualGateway"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdateVirtualGateway__en-us_topic_0000001735666528_response_VirtualGateway" frame="border" border="1" rules="all"><caption><b>Table 6 </b>VirtualGateway</caption><thead align="left"><tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row9545181061714"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p11548151014173">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p45482104174">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p654991019173">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row254641019174"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1554941041718">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1455001031716">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p14550141018172">Specifies the virtual gateway ID.</p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row5546141031713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p155014107172">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p255112108177">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p165511103179">Specifies the ID of the VPC connected by the virtual gateway.</p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row155462109177"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p145523109176">enterprise_router_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p55521910191716">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p4553121081711">Specifies the ID of the enterprise router that the virtual gateway is attached to.</p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row4546161018178"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p9553510131716">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p185542010101719">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p355412105174">Specifies the ID of the project that the instance belongs to.</p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1755591010171">Minimum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b13555210171716">32</strong></p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p5555810121720">Maximum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b95551510111715">32</strong></p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row154620100175"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p155511091717">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p175561110181711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p19556201031713">Specifies the virtual gateway name.</p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p35571810201715">Minimum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b14557131091713">0</strong></p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1055721001720">Maximum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b1557010151710">64</strong></p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row85461510121713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1155811081715">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p25581610171718">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p15595106177">Provides supplementary information about the virtual gateway.</p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p115595107177">Minimum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b13559181020179">0</strong></p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1955971019170">Maximum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b1155917109172">128</strong></p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row13546210161717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p20560151011171">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p175601610111710">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p14561111020172">Specifies the virtual gateway type. The value can only be <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b135611410181719">default</strong>.</p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p456191031711">Default: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b19561171017177">default</strong></p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row454651011714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1056216108178">local_ep_group</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p3562161020174">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p456311051717">Specifies the IPv4 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC.</p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row1954681011171"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p115631110171713">local_ep_group_ipv6</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p14563201015171">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p856481091710">Specifies the IPv6 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC. This is a reserved field.</p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row155461810191717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1956410102174">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p17565161091711">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p456551031711">Specifies the administrative status, which can be <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b1956641011171">true</strong> or <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b1956671011172">false</strong>.</p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p18566510101718">Default: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b20566101091719">true</strong></p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row1154620106172"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p45663100176">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1567161014179">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p5567111014177">Specifies the virtual gateway status, which can be <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b05686109176">ACTIVE</strong>, <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b165683106170">DOWN</strong>, <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b056841031720">BUILD</strong>, <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b656851020178">ERROR</strong>, <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b9568101001714">PENDING_CREATE</strong>, <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b11568111011173">PENDING_UPDATE</strong>, or <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b13568310151714">PENDING_DELETE</strong>.</p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row55461510181718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p0568181021713">bgp_asn</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1756914104177">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p165696102171">Specifies the local BGP ASN of the virtual gateway.</p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p18569610111713">Minimum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b10570910171719">1</strong></p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p105701410131712">Maximum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b18570310111710">4294967295</strong></p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row17547610161717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p457081014177">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p115719105176">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1557111021713">Specifies the ID of the enterprise project that the virtual gateway belongs to.</p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1557221021717">Minimum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b17572910111718">36</strong></p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p15725103175">Maximum: <strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b18572161018174">36</strong></p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row1254713104179"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1957291071713">device_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p5573410101711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p85743104176">Specifies the ID of the device that the virtual interface belongs to.</p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row1354711101178"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p145741510111716">redundant_device_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1157561001717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1857551061720">Specifies the ID of the redundant device.</p>
</td>
</tr>
<tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row85471610151719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p2576151091713">public_border_group</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p14576101021712">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p95770103175">Specifies the public border group of the AZ, indicating whether the site is a HomeZones site.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateVirtualGateway__en-us_topic_0000001735666528_section1587191017173"><h4 class="sectiontitle">Example Requests</h4><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p6587181031716">Updating the name and description of a virtual gateway and changing its IPv4 subnet to 192.168.3.0/24</p>
<pre class="screen" id="UpdateVirtualGateway__en-us_topic_0000001735666528_screen958816100173">PUT https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways/20082c1b-3c99-48d8-8e8c-116af5d7e9f0
{
"virtual_gateway" : {
"name" : "update-vgw-c7b22",
"description" : "",
"local_ep_group" : [ "192.168.3.0/24" ]
}
}</pre>
</div>
<div class="section" id="UpdateVirtualGateway__en-us_topic_0000001735666528_section1559191020179"><h4 class="sectiontitle">Example Responses</h4><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p11591141011720"><strong id="UpdateVirtualGateway__en-us_topic_0000001735666528_b1259111016178">Status code: 200</strong></p>
<p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p359191021712">OK</p>
<ul id="UpdateVirtualGateway__en-us_topic_0000001735666528_ul11592810181712"><li id="UpdateVirtualGateway__en-us_topic_0000001735666528_li9592710121712">The virtual gateway associated with a VPC is updated.<pre class="screen" id="UpdateVirtualGateway__en-us_topic_0000001735666528_screen359361001719">{
"virtual_gateway" : {
"id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
"name" : "update-vgw-c7b22",
"description" : "",
"tenant_id" : "0605768a3300d5762f82c01180692873",
"vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
"device_id" : "26.151.63.100",
"redundant_device_id" : "26.152.128.20",
"type" : "default",
"status" : "ACTIVE",
"admin_state_up" : true,
"bgp_asn" : 64512,
"local_ep_group" : [ "192.168.3.0/24" ],
"enterprise_project_id" : "0",
"public_border_group" : "center"
},
"request_id" : "765f7aaf8f2edd0e719de564ef72e2de"
}</pre>
</li><li id="UpdateVirtualGateway__en-us_topic_0000001735666528_li276320107171">The virtual gateway that will be attached to an enterprise router is created.<pre class="screen" id="UpdateVirtualGateway__en-us_topic_0000001735666528_screen77631810171714">{
"virtual_gateway" : {
"name" : "update-vgw-c7b22",
"id" : "7a91797a-cbda-42ff-9f42-73f26c993dd9",
"description" : "",
"tenant_id" : "92ea72fe26294aa180a2712c28e43c21",
"vpc_id" : null,
"enterprise_router_id" : "61fa53c9-4446-4ebd-89b9-11a52b653a9c",
"device_id" : "26.151.63.100",
"redundant_device_id" : "26.152.128.20",
"type" : "default",
"status" : "ACTIVE",
"admin_state_up" : true,
"bgp_asn" : 64512,
"local_ep_group" : [ "192.168.3.0/24" ],
"local_ep_group_ipv6" : null,
"public_border_group" : null
},
"request_id" : "765f7aaf8f2edd0e719de564e87g452f"
}</pre>
</li></ul>
</div>
<div class="section" id="UpdateVirtualGateway__en-us_topic_0000001735666528_section878817109178"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateVirtualGateway__en-us_topic_0000001735666528_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row11636171011171"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1778821019179">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p187881310101713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateVirtualGateway__en-us_topic_0000001735666528_row563671017173"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p57881510151720">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p15788510181717">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateVirtualGateway__en-us_topic_0000001735666528_section207882108172"><h4 class="sectiontitle">Error Codes</h4><p id="UpdateVirtualGateway__en-us_topic_0000001735666528_p1978931011174">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">Virtual Gateway</a></div>
</div>
</div>
View Git Blame Copy Permalink