yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
03e77f3e5b0080047fdcb72efdfd3333dd3bcf92
doc-exports/docs/vpn/api-ref/vpn_api_0069.html
Hongwei, King Wang 708fdb2d21 vpn_api_20250707 
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
Co-committed-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
2025-08-19 13:38:54 +00:00

534 lines
66 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002377888281"></a><a name="EN-US_TOPIC_0000002377888281"></a>
<h1 class="topictitle1">Changing the Specification of a Gateway</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_section78181831185517"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p9754145013552">This API is used to change the specification of a gateway. Currently, only pay-per-use gateways are supported.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_section738211382555"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p481411414564">For details, see <a href="vpn_api_0008.html#EN-US_TOPIC_0000001807530276">Calling APIs</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_section134852835617"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p8621153813562">POST /v5/{project_id}/vpn-gateways/{vgw_id}/update-specification</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_table3672032" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row10026740"><th align="left" class="cellrowborder" valign="top" width="20.61793820617938%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p6859639">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.02809719028097%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p179611479215">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.778822117788222%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p18759866">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.57514248575143%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p43154149">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row5825185"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p89156147572">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.02809719028097%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p16915151419570">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.778822117788222%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1691571416577">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.57514248575143%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p159151114125716">Specifies a project ID. You can obtain the project ID by referring to <a href="vpn_api_0051.html#EN-US_TOPIC_0000001807530332">Obtaining the Project ID</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row195301319570"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p591611144573">vgw_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.02809719028097%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p4136165717514">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.778822117788222%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p7136195714514">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.57514248575143%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p7136105718513">Specifies the ID of a VPN gateway instance.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_section1491505583"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul476016518584"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li59922337473">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_table65426" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row888119174611"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p128826144612">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p888213111469">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p888251154619">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p788261194616">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row19881515468"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p6311158209">vpn_gateway</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p173113581103"><a href="#EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_table92196">UpdateVgwSpecificationRequestBodyContent</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p231658605">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1031258602">Specifies the VPN gateway object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_table92196"></a><a name="en-us_topic_0000001930413634_table92196"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_table92196" frame="border" border="1" rules="all"><caption><b>Table 3 </b>UpdateVgwSpecificationRequestBodyContent</caption><thead align="left"><tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row17982141112440"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p11982511184419">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1498231116442">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p2098381112443">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p20983151154419">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row498231134419"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p123411027619">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1341102710112">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p18341927915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul334113271219"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li6341102710117">Specifies the new specification of the VPN gateway.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1115515218308">Value range:<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p51541626308"><a name="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1115515218308"></a><a name="en-us_topic_0000001930413634_li1115515218308"></a><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b6816172319286">Basic</strong>: The maximum forwarding bandwidth is 100 Mbit/s.</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p111547283014"><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b5231426122814">Professional1</strong>: The maximum forwarding bandwidth is 300 Mbit/s.</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1015415213309"><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b3942449423130">Professional1-NonFixedIP</strong>: The maximum forwarding bandwidth is 300 Mbit/s. (It is currently not supported.)</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p14154112163012"><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b315345711172">Professional2</strong>: The maximum forwarding bandwidth is 1 Gbit/s.</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p8154123306"><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b18539709063133">Professional2-NonFixedIP</strong>: The maximum forwarding bandwidth is 1 Gbit/s. (It is currently not supported.)</p>
<div class="note" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_note1715185895118"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1259951175215"><span id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ph1043115365910">The specification of a VPN gateway cannot be changed between Basic and Professional.</span></p>
</div></div>
</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li123419272111">For details about the value range supported by each gateway, see the <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b157973182410">supported_flavors</strong> field in the response to the request for <a href="vpn_api_0015.html#EN-US_TOPIC_0000001854089181">Querying a Specified VPN Gateway</a>.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li5159111218">Example request<pre class="screen" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_screen118117571923">POST https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id}/update-specification
{
"vpn_gateway": {
"flavor": "Basic"
}
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_section159431524536"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul3333112316512"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li61441714114816">Response parameters<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p15147105711514"><a name="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li61441714114816"></a><a name="en-us_topic_0000001930413634_li61441714114816"></a>Returned status code 200: successful operation</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_table72066" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameters in the response body</caption><thead align="left"><tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row13148957656"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p2014811571759">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p114819571514">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p111481457856">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row11482576516"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p114811571759">vpn_gateway</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p131311534195311"><a href="#EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_table92166">ResponseVpnGateway</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p3149115711518">Specifies the VPN gateway object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row8148857657"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1214916577517">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p171491057253">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p10149357758">Specifies a request ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_table92166"></a><a name="en-us_topic_0000001930413634_table92166"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_table92166" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ResponseVpnGateway</caption><thead align="left"><tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row14385131665410"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p113871916145418">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1038731617549">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p163881216155413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row11385141605411"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p136518913597">id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p66512919596">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul166514995911"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1065179135919">Specifies a VPN gateway ID.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li3656915592">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row17385016205416"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p76520920591">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p76519125915">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul96539185910"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li146529185914">Specifies the name of a VPN gateway.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li06511916595">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), and hyphens (-).</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row1738501615419"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p8800101572317">network_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p2800191592313">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul13252145262311"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li425275211230">Specifies the network type of the VPN gateway.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1325245222313">Value range:<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p4329192411713"><a name="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1325245222313"></a><a name="en-us_topic_0000001930413634_li1325245222313"></a><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b47333654033427">public</strong>: public network</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p78323108159"><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b17468780233823">private</strong>: private network</p>
</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li225215211231">The default value is <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b97591850102619">public</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row73851316135419"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p86613913596">attachment_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1566197597">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul11662912595"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li17661794599">Specifies the association mode.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li6662965917">Value range:<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p5379111116136"><a name="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li6662965917"></a><a name="en-us_topic_0000001930413634_li6662965917"></a><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b128862734333339">vpc</strong>: virtual private cloud.</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p196371712121311"><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b20526632903840">er</strong>: enterprise router</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row103387222810"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1232143013811">ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1423216301682">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul32321230581"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li192325303815">Specifies the IP protocol version of the VPN gateway.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li92332309818">The value is <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b1360012241293">ipv4</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row13861016195413"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p106616915598">er_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p17661492592">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1066149105917">Specifies the ID of the enterprise router instance to which the VPN gateway connects. This parameter is available only when <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b11813121919276">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b18141119112717">er</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row1638613167549"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p96617920597">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p196614912595">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p7776103116"><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b1871058145113942">vpc_id</strong> specifies the ID of the service VPC associated with the VPN gateway. This parameter is available only when <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b1485832838113948">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b1275402520113948">vpc</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row73861016105410"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p843133355913">local_subnets</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p143117332595">Array of String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1540242195016">Specifies a local subnet. This subnet is a cloud-side subnet that needs to communicate with an on-premises network through a VPN.</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p12912144445015">An example subnet is 192.168.52.0/24.</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p134311333175917">This parameter is returned only when <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b139233376110">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b492315374115">vpc</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row035319322595"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1516115304573">local_subnets_v6</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p625174345713">Array of String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p795944714273">(Currently not supported) Specifies an IPv6 local subnet. This subnet is a cloud-side subnet that needs to communicate with an on-premises network through a VPN.</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p136901537175810">An example subnet is 16af:cacc:1097::/48. This parameter is returned only when <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b181437606593812">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b19131780293812">vpc</strong> and <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b85382871693812">ip_version</strong> is set to <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b166415718293812">ipv6</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row4386121615547"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p46649125913">connect_subnet</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p7666965911">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p16617919593">Specifies the ID of the VPC subnet used by the VPN gateway.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row738621613542"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p5667925919">bgp_asn</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p18661996599">Long</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p866199185913">Specifies the BGP AS number of the VPN gateway.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row838616160541"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p196689185916">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p186614975917">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul16311126192517"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1131111619251">Specifies the specification of the VPN gateway.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li138324136257">Value range:<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1824457132913"><a name="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li138324136257"></a><a name="en-us_topic_0000001930413634_li138324136257"></a><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b370350908">Basic</strong>: The maximum forwarding bandwidth is 100 Mbit/s.</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1570711910299"><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b1904882551">Professional1</strong>: The maximum forwarding bandwidth is 300 Mbit/s.</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p14453043132613"><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b518562810287">Professional1-NonFixedIP</strong>: The maximum forwarding bandwidth is 300 Mbit/s. (It is currently not supported.)</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p114585512299"><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b13236173082817">Professional2</strong>: The maximum forwarding bandwidth is 1 Gbit/s.</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1438515529263"><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b5132326283">Professional2-NonFixedIP</strong>: The maximum forwarding bandwidth is 1 Gbit/s. (It is currently not supported.)</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row9142613112117"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p966095596">availability_zone_ids</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p266199195913">Array of String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p116615913593">Specifies the AZ where the VPN gateway is deployed. This parameter is available when an AZ is specified. If no AZ is specified, this parameter is available only when the VPN gateway is in ACTIVE state.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row16568151014497"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1367711217340">connection_number</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p292181374">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1967742133416">Specifies the maximum number of VPN connections supported for the VPN gateway.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row338611163542"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p7664925913">used_connection_number</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p8678920596">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p7671793597">Specifies the number of VPN connections that have been used by the VPN gateway.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row038661610546"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p06789125910">used_connection_group</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p116719195915">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p15676915918">Specifies the number of VPN connection groups that have been used by the VPN gateway. A connection group consists of two connections between a customer gateway and a VPN gateway. By default, 10 VPN connection groups are included free of charge with the purchase of a VPN gateway.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row83863161540"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p9671195593">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1677910594">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul1767196593"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li96712935914">Specifies an enterprise project ID.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li667797597">The value is a UUID containing 36 characters. If no enterprise project ID is specified during VPN gateway creation, 0 is returned, indicating that the resource belongs to the default enterprise project.<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p19677925918"><a name="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li667797597"></a><a name="en-us_topic_0000001930413634_li667797597"></a>Note that 0 is not the ID of an existing enterprise project.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row3386916205418"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p56712955914">eip1</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p167199105911"><a href="#EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_table92167">ResponseEip</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1678910593">Specifies the first EIP of the VPN gateway in the active-active mode or the active EIP of the VPN gateway in the active/standby mode. This parameter is available when the VPN gateway is in ACTIVE state.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row12386161655413"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p9675914595">eip2</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p36716915592"><a href="#EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_table92167">ResponseEip</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p56713916595">Specifies the second EIP of the VPN gateway in the active-active mode or the standby EIP of the VPN gateway in the active/standby mode. This parameter is available when the VPN gateway is in ACTIVE state.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row54683412319"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1767997599">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p12679925914">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul53102818255"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li25641930152512">Specifies the time when the VPN gateway is created. This parameter is available when the VPN gateway is in ACTIVE state.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li16311628142516">The UTC time format is <em id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_i9337907263163">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row1577915354313"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1667149165915">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p3671098590">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul6106151392213"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li97661522172218">Specifies the last update time. This parameter is available when the VPN gateway is in ACTIVE state.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1277785732017">The UTC time format is <em id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_i9924952973163">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row127551930162013"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p10515849151018">master_eip</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p166282941713">master_eip</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p12532752487">Specifies the first EIP used by the VPN gateway. This parameter is available when the VPN gateway is in ACTIVE state.</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p44963582149">This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row8177193362012"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p175159499105">slave_eip</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1362812991710">slave_eip</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p361195591415">Specifies the second EIP used by the VPN gateway. This parameter is available when the VPN gateway is in ACTIVE state.</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p16906348131418">This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row1518611371632"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p896144115225">access_vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p189624116227">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul15906343192415"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li8906114317244">Specifies the ID of the access VPC used by the VPN gateway.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li14906114318244">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row1024212392311"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p153418072512">access_subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p8534170132513">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul7121212102510"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1612131216253">Specifies the ID of the subnet in the access VPC used by the VPN gateway.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li312141282510">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row610021812412"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1549105802613">access_private_ip_1</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p19549165852610">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p25491258162611">Specifies a private IP address used by the VPN gateway to connect to a customer gateway when the network type is private network. This address is the first private IP address of the VPN gateway in active-active mode or the active private IP address of the VPN gateway in the active/standby mode.</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1866842616281">An example is 192.168.52.9. This parameter is available only when <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b191611529163118">network_type</strong> is set to <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b51611329153118">private</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row126735109104"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1188031315114">access_private_ip_2</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1288014137116">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p88809138114">Specifies a private IP address used by the VPN gateway to connect to a customer gateway when the network type is private network. This address is the second private IP address of the VPN gateway in active-active mode or the standby private IP address of the VPN gateway in the active/standby mode.</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p588011131712">An example is 192.168.52.9. This parameter is available only when <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b1129343010315">network_type</strong> is set to <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b5293183043119">private</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row12844205120540"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p13236155184320">ha_mode</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p202378552435">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul13646123254417"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li106152124813">Specifies the HA mode of the gateway. The value can be <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b84421339153115">active-active</strong> or <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b16442339163114">active-standby</strong>.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1779615212445">Value range: active-active, active-standby</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row8195122236"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p14785225145413">tags</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p147855259548">Array of <a href="vpn_api_0017.html#EN-US_TOPIC_0000001807370460__en-us_topic_0000001543673228_table4138248135518">VpnResourceTag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1280042717591">Specifies a tag list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_table92167"></a><a name="en-us_topic_0000001930413634_table92167"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_table92167" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ResponseEip</caption><thead align="left"><tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row34260162549"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.4.2.4.1.1"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p252412167540">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.4.2.4.1.2"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p0524181617544">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.4.2.4.1.3"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1352420166549">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row8426131675417"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p13619157596">id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p83661520598">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul46511446346"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li76516442344">Specifies an EIP ID.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li165344143419">The value is a UUID containing 36 characters. If the default enterprise project is used, 0 is returned.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row104261316125417"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p17371215175916">ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p5379151592">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul11582855187"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li11582145519817">Specifies the EIP version.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li20181917911">The value can only be <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b371093203214">4</strong>, indicating IPv4 address.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row242620169548"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p538215105912">type</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p203801512598">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul17823135518714"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li18823355977">Specifies the EIP type.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li17551112712217">The value can be <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b1440818507014">5_bgp</strong> (dynamic BGP).<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p4623162812212">For the value range, see the <strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b283371033613">type</strong> field in "Assigning an EIP" in the <em id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_i128336109364">Elastic IP API Reference</em>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row14261516165410"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p17142141545915">ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1714291517592">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul15421714152513"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li154314147253">Specifies an EIP, that is, a public IPv4 address.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li8589191913253">The value is an IPv4 address, for example, 88.***.***.11.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row142616166546"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1014220157595">charge_mode</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p151421915155915">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul1920245802910"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li520275812917">Specifies the billing mode of EIP bandwidth.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1962150143010">Value range:<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p63535542453"><a name="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1962150143010"></a><a name="en-us_topic_0000001930413634_li1962150143010"></a><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b0856821173316">bandwidth</strong>: billed by bandwidth</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p5507016018"><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b11645192393312">traffic</strong>: billed by traffic</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row11426151665416"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p2014241555917">bandwidth_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p11142121519594">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul2060210573114"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1060213523118">Specifies the bandwidth ID of an EIP.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li155137173112">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row7426316135412"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p61421315125918">bandwidth_size</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p51423152595">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul3179104382717"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1717944317270">Specifies the bandwidth (Mbit/s) of an EIP. The maximum EIP bandwidth varies according to regions and depends on the EIP service. You can submit a service ticket to increase the maximum EIP bandwidth under your account.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li417025410273">The value ranges from 1 to 1000. For details, see the EIP documentation.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row1042621618543"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p2014313153595">bandwidth_name</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p18143101520593">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul1923211458282"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li923314517284">Specifies the bandwidth name of an EIP.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li14671181410296">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), hyphens (-), and periods (.).</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row1734957831"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p29981812123319">share_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p9998512133313">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul8285155104116"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1448192717411">Specifies the bandwidth type.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1450603615412">Value range:<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p8749123818418"><a name="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1450603615412"></a><a name="en-us_topic_0000001930413634_li1450603615412"></a><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b97081141135214">PER</strong>: dedicated bandwidth</p>
<p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1742515361826"><strong id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_b56135485193618">WHOLE</strong>: shared bandwidth</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_table4138248135518" frame="border" border="1" rules="all"><caption><b>Table 7 </b>VpnResourceTag</caption><thead align="left"><tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row313874885517"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.5.2.4.1.1"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p1613864810559">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.009999999999998%" id="mcps1.3.5.2.1.5.2.4.1.2"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p11138114805517">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.769999999999996%" id="mcps1.3.5.2.1.5.2.4.1.3"><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p913874812558">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row5138148125515"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p86437477589">key</p>
</td>
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p11643144711589">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul96313327214"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1303152053315">Specifies a tag key.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li1863223214212">The value is a string of 1 to 128 characters that can contain digits, letters, Spanish characters, Portuguese characters, spaces, and special characters (_ . : = + - @).</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_row16139174885513"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p16643847205814">value</p>
</td>
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p764324795815">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul961219349376"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li5601175311451">Specifies a tag value.</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li186123345379">The value is a string of 0 to 255 characters that can contain digits, letters, Spanish characters, Portuguese characters, spaces, and special characters (_ . : = + - @).</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ul431113573613"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li17268103325217">Example response<ol id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ol1359912431784"><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li11599343580">Response to the request for updating a VPN gateway that does not support access via non-fixed IP addresses<pre class="screen" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_screen1321335881013">{
"vpn_gateway": {
"id": "620d99b8-demo-a8df-va86-200b868f2d7d",
"name": "vpngw-4321",
"attachment_type": "vpc",
"network_type": "public",
<span id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_ph5704191915156"> "ip_version": "ipv4",</span>
"vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c",
"local_subnets": [
"192.168.0.0/24"
],
"connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114",
"bgp_asn": 64512,
"flavor": "Professional1",
"availability_zone_ids": ["eu-de-01", "eu-de-02"],
"connection_number": 200,
"used_connection_number": 0,
"used_connection_group": 0,
"enterprise_project_id": "0",
"eip1": {
"id": "f1469b4a-demo-a8df-va86-bb7de91cf493",
"ip_version": 4,
"type": "5_bgp",
"ip_address": "88.***.***.102",
"charge_mode": "bandwidth",
"bandwidth_id": "cff40e5e-demo-a8df-va86-7366077bf097",
"bandwidth_size": 300,
"bandwidth_name": "vpngw-bandwidth-1391"
},
"eip2": {
"id": "6ad8e297-demo-a8df-va86-da0f885ccb98",
"ip_version": 4,
"type": "5_bgp",
"ip_address": "88.***.***.188",
"charge_mode": "bandwidth",
"bandwidth_id": "d290f1ee-demo-a8df-va86-d701748f0851",
"bandwidth_size": 300,
"bandwidth_name": "vpngw-bandwidth-1392"
},
"created_at": "2025-06-15T08:56:09.386Z",
"updated_at": "2025-06-15T11:13:13.677Z",
"access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa",
"access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114",
"ha_mode": "active-active"
},
"request_id": "33a2b77a-65f9-4fa0-90bd-4bd42038eb41"
}</pre>
</li><li id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_li683405410810">Response returned when a VPN gateway being created fails to be updated<pre class="screen" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_screen9222134771211">{
"error_code":"VPN.0003",
"error_msg":"resource (type=GATEWAY, ID=ff9bdca6-demo-a8df-va86-e4bcc1ea52bc) is not ready, currently CREATING",
"request_id": "abafe41c-7744-41af-bf3d-4452872af799"
}</pre>
</li></ol>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_section31981619"><h4 class="sectiontitle">Status Codes</h4><p id="EN-US_TOPIC_0000002377888281__en-us_topic_0000001930413634_p18112112662914">For details, see <a href="vpn_api_0052.html#EN-US_TOPIC_0000001807370508">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0013.html">S2C VPN Gateway</a></div>
</div>
</div>
View Git Blame Copy Permalink