forked from docs/doc-exports
Qin Ying, Fan
62ab8a5fe2
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>
159 lines
12 KiB
HTML
159 lines
12 KiB
HTML
<a name="en-us_topic_0055025326"></a><a name="en-us_topic_0055025326"></a>
|
|
|
|
<h1 class="topictitle1">Updating a Virtual Gateway</h1>
|
|
<div id="body1489114536418"><div class="section" id="en-us_topic_0055025326__section10267951"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0055025326__p15526968">This API is used to update a virtual gateway.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025326__section25302698"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0055025326__p1593711711268">PUT /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025326__table78013327231" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0055025326__row128753217231"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.3.2.5.1.1"><p id="en-us_topic_0055025326__p1587432182316">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.3.2.5.1.2"><p id="en-us_topic_0055025326__p1694123232312"><strong id="en-us_topic_0055025326__b842352706165439">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.3.2.5.1.3"><p id="en-us_topic_0055025326__p894632182312"><strong id="en-us_topic_0055025326__b842352706192549">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43%" id="mcps1.3.2.3.2.5.1.4"><p id="en-us_topic_0055025326__p7941332152315"><strong id="en-us_topic_0055025326__b84235270615331">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025326__row1994932152311"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en-us_topic_0055025326__p1594203215232">virtual_gateway_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en-us_topic_0055025326__p794173252315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en-us_topic_0055025326__p2103173217239">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en-us_topic_0055025326__p010343252316">Specifies the virtual gateway ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025326__section36252627"><a name="en-us_topic_0055025326__section36252627"></a><a name="section36252627"></a><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0055025326__p21078426103641"><a href="#en-us_topic_0055025326__table50992744154526">Table 2</a> lists the request parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025326__table50992744154526"></a><a name="table50992744154526"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025326__table50992744154526" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="en-us_topic_0055025326__row20073554154526"><th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.3.3.2.5.1.1"><p id="en-us_topic_0055025326__p15345186154526">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.3.3.2.5.1.2"><p id="en-us_topic_0055025326__p35000534154526"><strong id="en-us_topic_0055025326__b729247583">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.3.3.2.5.1.3"><p id="en-us_topic_0055025326__p16470999154526"><strong id="en-us_topic_0055025326__b1136526189">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.44444444444445%" id="mcps1.3.3.3.2.5.1.4"><p id="en-us_topic_0055025326__p59082508154526">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025326__row20953821154526"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-us_topic_0055025326__p19537972154526">virtual_gateway</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en-us_topic_0055025326__p39071862154526">Dictionary</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en-us_topic_0055025326__p10704269154526">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.44444444444445%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en-us_topic_0055025326__p61739489154526">Specifies the <strong id="en-us_topic_0055025326__b842352706191940">virtual_gateway</strong> object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025326__table125648759846" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0055025326__row265942339846"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.4.1.5.1.1"><p id="en-us_topic_0055025326__p351661709915"><strong id="en-us_topic_0055025326__b8423527069918">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.4.1.5.1.2"><p id="en-us_topic_0055025326__p89913189915"><strong id="en-us_topic_0055025326__b1236977384">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.4.1.5.1.3"><p id="en-us_topic_0055025326__p209180099915"><strong id="en-us_topic_0055025326__b1898084418">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.3.4.1.5.1.4"><p id="en-us_topic_0055025326__p132751689915"><strong id="en-us_topic_0055025326__b1243625453">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025326__row66033117145224"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.4.1.5.1.1 "><p id="en-us_topic_0055025326__p15341960145224">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.1.5.1.2 "><p id="en-us_topic_0055025326__p34739281145224">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.1.5.1.3 "><p id="en-us_topic_0055025326__p62418382145224">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.4.1.5.1.4 "><p id="en-us_topic_0055025326__p22724200145224">Provides supplementary information about the virtual gateway.</p>
|
|
<p id="en-us_topic_0055025326__p1070082118411"><span id="en-us_topic_0055025326__text243011117548">Angle brackets (<>) are not allowed.</span></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025326__row52076255145224"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.4.1.5.1.1 "><p id="en-us_topic_0055025326__p57161530145224">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.1.5.1.2 "><p id="en-us_topic_0055025326__p66681242145224">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.1.5.1.3 "><p id="en-us_topic_0055025326__p32471539145224">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.4.1.5.1.4 "><p id="en-us_topic_0055025326__p12948972145224">Specifies the virtual gateway name.</p>
|
|
<p id="en-us_topic_0055025326__p35081830113419"><span id="en-us_topic_0055025326__text15699204710333">Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.</span></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025326__row22650581145251"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.4.1.5.1.1 "><p id="en-us_topic_0055025326__p38440998145251">local_ep_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.1.5.1.2 "><p id="en-us_topic_0055025326__p26713113145251">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.1.5.1.3 "><p id="en-us_topic_0055025326__p16278516145251">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.4.1.5.1.4 "><p id="en-us_topic_0055025326__p43491424145251">Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025326__section57838187"><a name="en-us_topic_0055025326__section57838187"></a><a name="section57838187"></a><h4 class="sectiontitle">Response</h4><p id="en-us_topic_0055025326__p17268844145745"><a href="#en-us_topic_0055025326__table4284712915501">Table 3</a> lists the response parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025326__table4284712915501"></a><a name="table4284712915501"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025326__table4284712915501" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter</caption><thead align="left"><tr id="en-us_topic_0055025326__row4552452315501"><th align="left" class="cellrowborder" valign="top" width="28.000000000000004%" id="mcps1.3.4.3.2.4.1.1"><p id="en-us_topic_0055025326__p6360776715501">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.4.3.2.4.1.2"><p id="en-us_topic_0055025326__p5195553615501">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48%" id="mcps1.3.4.3.2.4.1.3"><p id="en-us_topic_0055025326__p3435514315501">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025326__row3130318915501"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025326__p5253038415501">virtual_gateway</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025326__p2710268715501">Dictionary</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025326__p4935093915501">Specifies the <strong id="en-us_topic_0055025326__b842352706192031">virtual_gateway</strong> object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="en-us_topic_0055025326__p1023625610325">For details about the <strong id="en-us_topic_0055025326__b14309341049">virtual_gateway</strong> field, see <a href="en-us_topic_0055025321.html#en-us_topic_0055025321__en-us_topic_0070676570_table49902238182444">Table 1</a>.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025326__section5055526711495"><a name="en-us_topic_0055025326__section5055526711495"></a><a name="section5055526711495"></a><h4 class="sectiontitle">Examples</h4><ul id="en-us_topic_0055025326__ul167491055192817"><li id="en-us_topic_0055025326__li77491655122813">Example request<pre class="screen" id="en-us_topic_0055025326__screen4017959713452">PUT /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
|
|
{
|
|
"virtual_gateway" : {
|
|
"name" : "virtual gateway1",
|
|
"description" : "New description"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="en-us_topic_0055025326__ul15710118172911"><li id="en-us_topic_0055025326__li16710481294">Example response<pre class="screen" id="en-us_topic_0055025326__screen1750762082916">{
|
|
"virtual_gateway" : {
|
|
"id": "0a0888a6-4096-43a6-81c6-923912933451",
|
|
"name": "virtual gateway1",
|
|
"description": "New description",
|
|
"tenant_id": "0605768a3300d5762f82c01180692873",
|
|
"vpc_id": "5352423b-b4ff-4a9e-839d-02698c2b36af",
|
|
"local_ep_group_id": "f8834cf1-5468-87c7-223d-56e78b9699ab",
|
|
"local_ep_group_ipv6_id": null,
|
|
"device_id": "aaa_01",
|
|
"redundant_device_id": null,
|
|
"type": "default",
|
|
"ipsec_bandwidth": 1,
|
|
"status": "PENDING_CREATE",
|
|
"admin_state_up": true,
|
|
"bgp_asn": null,
|
|
"region_id": null
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="en-us_topic_0055025326__section1374333103913"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0055025326__p176816317298">For details, see <a href="en-us_topic_0055025342.html">Common Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0055025320.html">Virtual Gateway</a></div>
|
|
</div>
|
|
</div>
|
|
|