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

108 lines
12 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001854089217"></a><a name="EN-US_TOPIC_0000001854089217"></a>
<h1 class="topictitle1">Example 2: Creating a Customer Gateway</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_section827723815517"><h4 class="sectiontitle">Scenario</h4><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p17518164418559">This section describes how to create a customer gateway by calling APIs.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_section3353257135516"><h4 class="sectiontitle">Prerequisites</h4><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p66733617566">You have obtained a user token if you need to use token authentication. In addition, you need to add <strong id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_b34353317280">X-Auth-Token</strong> to the request header when calling an API. For details about token authentication, see "Authentication" in the <em id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_i369318443319">Virtual Private Cloud API Reference</em>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_section96477188567"><h4 class="sectiontitle">Data Preparation</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_table444111294349" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Key parameters in the request for creating a customer gateway</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_row3459182917345"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.2.4.1.1"><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p194595291340">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.2.4.1.2"><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p2459112916345">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.2.4.1.3"><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p11459102913414">Example Value</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_row7459122923420"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p74596297347">name</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p11459929193418">Specifies a customer gateway name.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p645910291347">stub-customer-gateway-id-1</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_row983893718349"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p12677338484">route_mode</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p1283814373343">Specifies the gateway routing mode.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p5838133711347">static</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_row337514017345"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p18375840133418">ip</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p83751440153410">Specifies the IP address of the customer gateway.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p1337564019342">10.12.13.21</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_section77866372561"><h4 class="sectiontitle">Procedure</h4><ol id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_ol1033516371743"><li id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_li133351379413">Create a customer gateway.<ol type="a" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_ol7630731105015"><li id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_li18354814195019">Send <strong id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_b1528673113016">POST https://{endpoint}/v5/{project_id}/customer-gateways</strong>.</li><li id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_li12354121485016">Add <strong id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_b21345826650514">X-Auth-Token</strong> to the request header.</li><li id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_li735414146508">Specify the following parameters in the request body:<pre class="screen" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_screen1778465375316">{
"customer_gateway": {
"name": "cgw-3ebf",
"id_type": "ip",
"id_value": "10.***.***.21"
}
}</pre>
</li><li id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_li1963133185019">Check the response.<ul id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_ul1363113195012"><li id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_li1463173112507">The request is successful if the following response is displayed. In the response, <strong id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_b16141428115518">id</strong> indicates a customer gateway ID.<div class="codecoloring" codetype="Json" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_screen1049818563202"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;customer_gateway&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;03c0aa3d-demo-a8df-va86-9d82473765d4&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;cgw-3ebf&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;id_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ip&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;id_value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;10.***.***.21&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;created_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2024-06-25T13:19:37.335+02:00&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;updated_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2024-06-25T13:19:37.335+02:00&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;request_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;e55783ba-5cc8-40c1-ad81-12cce6f773d2&quot;</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</li></ol>
</li><li id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_li1355101465012">Query details about the customer gateway.<ol type="a" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_ol95722017111819"><li id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_li557281720184">Send <strong id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_b18282205714011">GET https://{endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id}</strong>.</li><li id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_li1457214173183">Add <strong id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_b3661249940514">X-Auth-Token</strong> to the request header.</li><li id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_li15572717141815">Check the response.<ul id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_ul1057214178189"><li id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_li155727173189">The request is successful if the following response is displayed. In the response, <strong id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_b1381193316558">id</strong> indicates a customer gateway ID.<div class="codecoloring" codetype="Json" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_screen732511332114"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;customer_gateway&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;03c0aa3d-demo-a8df-va86-9d82473765d4&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;cgw-3ebf&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;id_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ip&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;id_value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;10.***.***.21&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;created_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2024-06-25T13:19:37.335Z&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;updated_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2024-06-25T13:19:37.335Z&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;request_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;8cf476c4-c3d4-4516-bfbc-01e2473e549b&quot;</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</li></ol>
</li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0039.html">Application Examples</a></div>
</div>
</div>
View Git Blame Copy Permalink