vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpn/api-ref/vpn_api_0021.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

305 lines
35 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001807530292"></a><a name="EN-US_TOPIC_0000001807530292"></a>
<h1 class="topictitle1">Creating a Customer Gateway</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_section20114008"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p1487610174615">This API is used to create a customer gateway to which a VPN gateway connects.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_section18104173342818"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p19989133162813">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_0000001807530292__en-us_topic_0000001594578249_section46808346"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p162426363498">POST /v5/{project_id}/customer-gateways</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_table3672032" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_p43154149">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row5825185"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p2077973">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_0000001807530292__en-us_topic_0000001594578249_p177965479212">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_0000001807530292__en-us_topic_0000001594578249_p34098154">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_0000001807530292__en-us_topic_0000001594578249_p199639252285">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>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_section18621933"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul5992193374713"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li59922337473">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_table65426" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_p788261194616">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_p68821314463">customer_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_0000001807530292__en-us_topic_0000001594578249_p1388214154618"><a href="#EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_table92196">CreateCgwRequestBodyContent</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_0000001807530292__en-us_topic_0000001594578249_p088212115465">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_0000001807530292__en-us_topic_0000001594578249_p158833119462">Specifies the customer gateway object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_table92196"></a><a name="en-us_topic_0000001594578249_table92196"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_table92196" frame="border" border="1" rules="all"><caption><b>Table 3 </b>CreateCgwRequestBodyContent</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_p20983151154419">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_p14983131174417">name</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_0000001807530292__en-us_topic_0000001594578249_p39837111443">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_0000001807530292__en-us_topic_0000001594578249_p19831111204412">No</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_0000001807530292__en-us_topic_0000001594578249_ul65231833153920"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1303152053315">Specifies the name of a customer gateway. If this parameter is not specified, a name in the format of <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b15481711102610">cgw-</strong><em id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_i143841416102618">****</em> is automatically generated, for example, <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b15674203917267">cgw-21a3</strong>.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li152316335391">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_0000001807530292__en-us_topic_0000001594578249_row860610253715"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p2606162103715">id_type</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_0000001807530292__en-us_topic_0000001594578249_p20607142113718">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_0000001807530292__en-us_topic_0000001594578249_p96071726374">No</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_0000001807530292__en-us_topic_0000001594578249_ul961219349376"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li186123345379">Specifies the identifier type of a customer gateway.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1726815246612">Value range:<ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul55935513618"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li17883658563">ip</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li159311511767">fqdn (currently not supported)</li></ul>
</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1612113412376">The default value is <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b10904125910711">ip</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row75128993814"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p55128913386">id_value</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_0000001807530292__en-us_topic_0000001594578249_p751389133817">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_0000001807530292__en-us_topic_0000001594578249_p1151317915389">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_0000001807530292__en-us_topic_0000001594578249_ul28313114110"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li38311194114">Specifies the identifier of a customer gateway.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li38311111412">The value is a string of 1 to 128 characters. When <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b1886650171620">id_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b886612014165">ip</strong>, the value is an IPv4 address in dotted decimal notation, for example, 192.168.45.7. When <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b5866305163">id_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b7867140161620">fqdn</strong>, the value is a string of characters that can contain uppercase letters, lowercase letters, digits, and special characters. Spaces and the following special characters are not supported: &amp; &lt; &gt; [ ] \ ?.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row10982311114417"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p19985141134410">bgp_asn</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_0000001807530292__en-us_topic_0000001594578249_p4985141116446">Long</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_0000001807530292__en-us_topic_0000001594578249_p1298515110447">No</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_0000001807530292__en-us_topic_0000001594578249_ul3945205718195"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li482611527344">Specifies the BGP AS number of the customer gateway.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li3104165182114">The value ranges from 1 to 4294967295.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li141281146133419">Set this parameter only when <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b13863174517284">id_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b1048917732910">ip</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row37216572032"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p12518647185817">tags</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_0000001807530292__en-us_topic_0000001594578249_p155181847125816">Array of <a href="#EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_table92238">VpnResourceTag</a> object</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_0000001807530292__en-us_topic_0000001594578249_p951834755816">No</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_0000001807530292__en-us_topic_0000001594578249_ul124531254455"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li84543256453">Specifies a tag list.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li145412253459">A maximum of 20 tags can be specified.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_table92238"></a><a name="en-us_topic_0000001594578249_table92238"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_table92238" frame="border" border="1" rules="all"><caption><b>Table 4 </b>VpnResourceTag</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row12907152516281"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.3.2.5.1.1"><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p1790862522818">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.3.2.5.1.2"><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p1590862511281">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.4.2.1.3.2.5.1.3"><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p190822518281">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.4.2.1.3.2.5.1.4"><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p11908132532819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row19907325142817"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p86437477589">key</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p11643144711589">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p764319470581">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul161261141134216"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li191269417428">Specifies a tag key.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li712715413426">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_0000001807530292__en-us_topic_0000001594578249_row129071625122816"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p16643847205814">value</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p764324795815">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p18643647195814">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul11127164111429"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li5601175311451">Specifies a tag value.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li81273416429">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><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li9371754115510">Example request<pre class="screen" id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_screen1778465375316">POST https://{Endpoint}/v5/{project_id}/vpn/customer-gateways
{
"customer_gateway": {
"name": "cgw-2abf",
"id_type": "ip",
"id_value": "10.***.***.21",
"bgp_asn": 65000,
}
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_section33379675"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul2144514204819"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li61441714114816">Response parameters<p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p1623112417119"><a name="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li61441714114816"></a><a name="en-us_topic_0000001594578249_li61441714114816"></a>Returned status code 201: successful creation</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_table92198" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters in the response body</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row14992101114413"><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_0000001807530292__en-us_topic_0000001594578249_p89930114442">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.88%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p12993191144414">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.900000000000006%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p129931111164410">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row17992181154416"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p18993131118440">customer_gateway</p>
</td>
<td class="cellrowborder" valign="top" width="24.88%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p9920651122818"><a href="#EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_table92199">ResponseCustomerGateway</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="52.900000000000006%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p19941811124415">Specifies the customer gateway object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row179920112445"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p1799461124418">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.88%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p2099481116449">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.900000000000006%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p13994191113443">Specifies a request ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_table92199"></a><a name="en-us_topic_0000001594578249_table92199"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_table92199" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ResponseCustomerGateway</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row19995121154420"><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_0000001807530292__en-us_topic_0000001594578249_p9995131144415">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_0000001807530292__en-us_topic_0000001594578249_p1997181113442">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_0000001807530292__en-us_topic_0000001594578249_p109971611154417">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row1299511119446"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p1899791115449">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_0000001807530292__en-us_topic_0000001594578249_p1599714115446">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_0000001807530292__en-us_topic_0000001594578249_ul4510103818305"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li156736439303">Specifies a customer gateway ID.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1525265511233">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row899515112444"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p11998111174414">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_0000001807530292__en-us_topic_0000001594578249_p20998611184415">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_0000001807530292__en-us_topic_0000001594578249_ul4955105118115"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li7955551161115">Specifies a customer gateway name. If no customer gateway name is specified, the system automatically generates one.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1987916110130">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_0000001807530292__en-us_topic_0000001594578249_row1767123085111"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p18721658125115">id_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_0000001807530292__en-us_topic_0000001594578249_p2072358145113">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_0000001807530292__en-us_topic_0000001594578249_ul151101711181511"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1511017115151">Specifies the identifier type of a customer gateway.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li16110111131514">Value range:<ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul1811012111159"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li151102115157">ip</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1211071141518">fqdn (currently not supported)</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row156651732125115"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p207245895119">id_value</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_0000001807530292__en-us_topic_0000001594578249_p1672358125117">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_0000001807530292__en-us_topic_0000001594578249_p1685712819529">Specifies the identifier of a customer gateway.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row209951211144414"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p129991311174411">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_0000001807530292__en-us_topic_0000001594578249_p169990110444">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_0000001807530292__en-us_topic_0000001594578249_p179561588484">Specifies the BGP AS number of the customer gateway. This parameter is available only when <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b199731154195911">id_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b1897355416592">ip</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row1399591119448"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p200201214446">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_0000001807530292__en-us_topic_0000001594578249_p16061216443">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_0000001807530292__en-us_topic_0000001594578249_ul137621456192816"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li176281122918">Specifies the time when the customer gateway is created.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li6762125612819">The UTC time format is <em id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_i190407511133924">yyyy-MM-ddTHH:mm:ss.SSS+02:00</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row159951311134419"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p111181254416">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_0000001807530292__en-us_topic_0000001594578249_p14181213448">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_0000001807530292__en-us_topic_0000001594578249_ul6106151392213"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li491725462212">Specifies the last update time.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1277785732017">The UTC time format is <em id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_i927614370483">yyyy-MM-ddTHH:mm:ss.SSS+02:00</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row750811114379"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_p147855259548">Array of <a href="#EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_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_0000001807530292__en-us_topic_0000001594578249_p1280042717591">Specifies a tag list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_table4138248135518"></a><a name="en-us_topic_0000001594578249_table4138248135518"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_table4138248135518" frame="border" border="1" rules="all"><caption><b>Table 7 </b>VpnResourceTag</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row313874885517"><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_0000001807530292__en-us_topic_0000001594578249_p1613864810559">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.009999999999998%" id="mcps1.3.5.2.1.4.2.4.1.2"><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p11138114805517">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.769999999999996%" id="mcps1.3.5.2.1.4.2.4.1.3"><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p913874812558">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row5138148125515"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p121761293375">key</p>
</td>
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p41771729153718">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul4177729133712"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1217762923713">Specifies a tag key.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li41771629103713">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_0000001807530292__en-us_topic_0000001594578249_row16139174885513"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p171774293371">value</p>
</td>
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p1617782919374">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul10177112943717"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1917702915375">Specifies a tag value.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li11177152993718">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><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li06801512155612">Example response<pre class="screen" id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_screen678017232489">{
"customer_gateway": {
"id": "03c0aa3d-demo-a8df-va86-9d82473765d4",
"name": "cgw-2abf",
"id_type": "ip",
"id_value": "10.***.***.21",
"bgp_asn": 65000,
"created_at": "2024-06-25T13:19:37.335+02:00",
"updated_at": "2024-06-25T13:19:37.335+02:00"
},
"request_id": "7e0383bf-a7fb-461b-a926-baa8a795bf1a"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_section31981619"><h4 class="sectiontitle">Status Codes</h4><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_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_0020.html">Customer Gateway</a></div>
</div>
</div>
View Git Blame Copy Permalink