vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpn/api-ref/vpn_api_1033.html
Hongwei, King Wang 32c06a10a2 vpn_api 
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
Co-committed-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
2024-08-15 14:18:28 +00:00

293 lines
29 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001854169217"></a><a name="EN-US_TOPIC_0000001854169217"></a>
<h1 class="topictitle1">Updating a VPN Service</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_section25709437"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p42711464">This API is used to update a VPN service.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_section30058349"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p1634503313456">PUT /v2.0/vpn/vpnservices/{service_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_table184162115335" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row984914219336"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p8849921163313">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p384918214339">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p208493212330">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p1185732118339">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row10857162110332"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p17857142117336">service_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p18857152173311">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p385772133310">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p28642214334">Specifies the VPN service ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_section18807190"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p167013504615"><a href="#EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_table24429894">Table 2</a> describes the request parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_table24429894"></a><a name="en-us_topic_0000001541296738_table24429894"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_table24429894" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row26383427"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p56682808">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p27904713">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p45689312">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p9846754">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row9359903"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p19954658">description</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p5714573">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p60227273">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p46570941">Provides supplementary information about the VPN service.</p>
<p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p3546045194215">The description can contain up to 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row16485292"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p60240296">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p47625841">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p32487918">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p14275720">Specifies the VPN service name.</p>
<p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p7407338164214">The name can contain 1 to 64 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row61372619"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p5126234">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p12571834">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p11685651">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p7013644">Specifies the administrative status, which can be <strong id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_b17756939193918">true</strong> or <strong id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_b27571039183918">false</strong>.</p>
<p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p15552192010432">Currently, <strong id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_b134599400391">admin_state_up</strong> can only be <strong id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_b134602040103917">true</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row5119113335613"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p1517818378567">order_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p417815373562">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p171781637165619">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p10178183705616">Specifies the ID of a yearly/monthly order.</p>
<p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p3372453205611">The ID can contain up to 255 characters.</p>
<p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p6729547491">This parameter is only available to yearly/monthly VPNs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row151192033185618"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p2179103735613">product_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p61791737105616">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p151794371561">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p11799373561">Specifies the ID of a product that is billed on a yearly/monthly basis.</p>
<p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p3415185535612">The ID can contain up to 255 characters.</p>
<p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p133255604910">This parameter is only available to yearly/monthly VPNs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row118709355560"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p1117910374562">prepay_connection_num</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p14179163714560">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p4179113795618">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p161791637125610">Specifies the number of connections of the yearly/monthly VPN service.</p>
<p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p2060558104920">This parameter is only available to yearly/monthly VPNs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row6870535135614"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p141791337105619">resource_speccode</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p10179163714568">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p161792373562">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p191794377564">Specifies the specifications of the product that is billed on a yearly/monthly basis.</p>
<p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p2368457115611">The specifications can contain up to 255 characters.</p>
<p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p1490325910490">This parameter is only available to yearly/monthly VPNs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row62741064"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p48861387">vpnservice</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p65458312">Object</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p523045">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p42366666">Specifies the VPN service object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_note11272103475"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p1125093019424">Parameter <strong id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_b1020154084013">project_id</strong> is not supported.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_section35046986"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p9782172794717"><a href="#EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_table9147936">Table 3</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_table9147936"></a><a name="en-us_topic_0000001541296738_table9147936"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_table9147936" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row55945983"><th align="left" class="cellrowborder" valign="top" width="29.759999999999998%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p35330790">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.77%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p43221770">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.47%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p43085863">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row294000"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p23814038">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p49888896">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p31118786">Specifies the VPN service ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row11633618"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p2799031">router_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p25394981">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p52271033">Specifies the router ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row677253"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p54857523">status</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p14274382">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p37356265">Specifies the VPN service status, which can be <strong id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_b842352706212822">ACTIVE</strong>, <strong id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_b842352706212827">DOWN</strong>, <strong id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_b842352706212832">BUILD</strong>, <strong id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_b842352706212835">ERROR</strong>, <strong id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_b842352706212840">PENDING_UPDATE</strong>, or <strong id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_b842352706212850">PENDING_DELETE</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row662065"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p53627266">name</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p48841284">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p2840889">Specifies the VPN service name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row25568006"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p57742629">external_v6_ip</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p46641368">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p64708380">Specifies the IPv6 address of the VPN service external gateway.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row45504511"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p61986789">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p54874019">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p56498634">Specifies the administrative status, which can be <strong id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_b451192717438">true</strong> or <strong id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_b2513192713436">false</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row38725660"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p49770771">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p4900679">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p8212356">Specifies the subnet ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row6802342"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p14118857">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p2776748">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p31742419">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row17246319"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p54774566">external_v4_ip</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p7554882">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p41245128">Specifies the IPv4 address of the VPN service external gateway.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row35661838"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p2927765">description</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p35822404">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p15556157">Provides supplementary information about the VPN service.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row172391328202013"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p17590742182016">order_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p059018423204">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p105901424206">Specifies the ID of a yearly/monthly order.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row6239172842019"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p1659094242016">product_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p059044242010">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p1359084262017">Specifies the ID of a product that is billed on a yearly/monthly basis.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row17239928182016"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p659024220202">prepay_connection_num</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p259019421202">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p17591144219201">Specifies the number of connections of the yearly/monthly VPN service.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row1423919286205"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p1159174252016">resource_speccode</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p11591144210208">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p359118427204">Specifies the specifications of the product that is billed on a yearly/monthly basis.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row14339154014201"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p125916422203">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p359114202013">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p195911042132013">Specifies the time when the VPN service was created.</p>
<p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p15396112118284">The time is in <em id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_i1116644395102443">YYYY-mm-dd HH:MM:SS.ffffff</em> format.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_row5787686"><td class="cellrowborder" valign="top" width="29.759999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p66149382">vpnservice</p>
</td>
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p56499698">Object</p>
</td>
<td class="cellrowborder" valign="top" width="48.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_p52268049">Specifies the VPN service object.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_section46987420"><h4 class="sectiontitle">Example</h4><ul id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_ul43765519471"><li id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_li1437675104711">Example request<pre class="screen" id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_screen48030134215957">PUT /v2.0/vpn/vpnservices/{service_id}
{
"vpnservice" : {
"description" : "Updated description"
}
}</pre>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_ul61961541480"><li id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_li119620414486">Example response<pre class="screen" id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_screen12299121514811">{
"vpnservice": {
"router_id": "881b7b30-4efb-407e-a162-5630a7af3595",
"status": "ACTIVE",
"name": "myvpn",
"admin_state_up": true,
"subnet_id": null,
"tenant_id": "26de9cd6cae94c8cb9f79d660d628e1f",
"id": "41bfef97-af4e-4f6b-a5d3-4678859d2485",
"description": "Updated description",
"order_id": "",
"product_id": "",
"prepay_connection_num": 0,
"resource_speccode": "",
"created_at": "2020-08-05 12:36:35.921257"
}
}</pre>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0000001854169217__en-us_topic_0000001541296738_en-us_topic_0053740035_p19515943486">For details, see <a href="vpn_api_1054.html#EN-US_TOPIC_0000001854089293">Common Returned Values</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_1029.html">VPN Service Management</a></div>
</div>
</div>
View Git Blame Copy Permalink