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

209 lines
24 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001807370468"></a><a name="EN-US_TOPIC_0000001807370468"></a>
<h1 class="topictitle1">Querying a Specified Customer Gateway</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_section20114008"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p156141423912">This API is used to query a customer gateway with a specified gateway ID.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_section18104173342818"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_section46808346"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p832123135010">GET /v5/{project_id}/customer-gateways/{customer_gateway_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_table92238" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row12907152516281"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p1790862522818">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p1590862511281">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p190822518281">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p11908132532819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row19907325142817"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p69098254284">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p090912572820">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p79091425122815">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_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>
<tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row129071625122816"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p199099259289">customer_gateway_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p390972582811">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p89091525192816">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p18910112513283">Specifies a customer gateway ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_section18621933"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul5992193374713"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li6680921111317">Request parameters<p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p0944102114137"><a name="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li6680921111317"></a><a name="en-us_topic_0000001594193229_li6680921111317"></a>None</p>
</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li1532653016562">Example request<pre class="screen" id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_screen1778465375316">GET https://{Endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_section33379675"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul2144514204819"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li61441714114816">Response parameters<p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p76201023211"><a name="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li61441714114816"></a><a name="en-us_topic_0000001594193229_li61441714114816"></a>Returned status code 200: successful query</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_table65428" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the response body</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row8231124516"><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_0000001807370468__en-us_topic_0000001594193229_p7241224912">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.66%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p17249248112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.12%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p124924816">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row62312241419"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p8247248119">customer_gateway</p>
</td>
<td class="cellrowborder" valign="top" width="24.66%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p185741616203"><a href="#EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_table92241">ResponseCustomerGateway</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="53.12%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p1524152418119">Specifies the customer gateway object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row152372416111"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p2250241516">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.66%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p152592414114">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.12%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p16259241120">Specifies a request ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_table92241"></a><a name="en-us_topic_0000001594193229_table92241"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_table92241" frame="border" border="1" rules="all"><caption><b>Table 3 </b>ResponseCustomerGateway</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row99164254288"><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_0000001807370468__en-us_topic_0000001594193229_p4918102512813">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_0000001807370468__en-us_topic_0000001594193229_p16918142513289">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_0000001807370468__en-us_topic_0000001594193229_p99191425152817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row14916172582819"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p3919102572812">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_0000001807370468__en-us_topic_0000001594193229_p591910250283">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_0000001807370468__en-us_topic_0000001594193229_ul4510103818305"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li156736439303">Specifies a customer gateway ID.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li1525265511233">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row12916152552813"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p1391952512818">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_0000001807370468__en-us_topic_0000001594193229_p391922552810">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_0000001807370468__en-us_topic_0000001594193229_ul4955105118115"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li7955551161115">Specifies a customer gateway name. If no customer gateway name is specified, the system automatically generates one.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li1987916110130">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_0000001807370468__en-us_topic_0000001594193229_row2098716504538"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_ul192612345211"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li2266317525">Specifies the identifier type of a customer gateway.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li665012020497">Value range:<ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul1911816484918"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li236335984813">ip</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li122673135214">fqdn (currently not supported)</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row18344155745319"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_p1685712819529">Specifies the identifier of a customer gateway.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row19161225132811"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_p179561588484">Specifies the BGP AS number of the customer gateway. This parameter is available only when <strong id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_b1837832291216">id_type</strong> is set to <strong id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_b937812210126">ip</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row109171625162815"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p992272572816">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_0000001807370468__en-us_topic_0000001594193229_p149220255281">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_0000001807370468__en-us_topic_0000001594193229_ul513957142318"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li102171311102320">Specifies the time when the customer gateway is created.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li1139167182311">The UTC time format is <em id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_i80808587533926">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row20917102512813"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p3923122511285">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_0000001807370468__en-us_topic_0000001594193229_p8923202562810">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_0000001807370468__en-us_topic_0000001594193229_ul6106151392213"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li6217011202319">Specifies the last update time.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li1277785732017">The UTC time format is <em id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_i209856832933926">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row27651616193811"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_p147855259548">Array of <a href="#EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_p1280042717591">Specifies a tag list.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row9135131855819"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p12677338484">route_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_0000001807370468__en-us_topic_0000001594193229_p17982130144014">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_0000001807370468__en-us_topic_0000001594193229_ul1579159184914"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li357912596498">Specifies the routing mode.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li557995918499">Value range:<p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p0822043105010"><a name="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li557995918499"></a><a name="en-us_topic_0000001594193229_li557995918499"></a><strong id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_b15840123212495">static</strong>: static routing mode</p>
<p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p182284315013"><strong id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_b9891133124918">bgp</strong>: BGP routing mode</p>
<p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p17921144813507">This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row1884162045811"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p18375840133418">ip</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_0000001807370468__en-us_topic_0000001594193229_p112761132403">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_0000001807370468__en-us_topic_0000001594193229_ul57421722105011"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li7742162205010">Specifies the IP address of the customer gateway.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li574292217508">The value is an IPv4 address, for example, 10.***.***.21.<p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p85381336165016"><a name="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li574292217508"></a><a name="en-us_topic_0000001594193229_li574292217508"></a>This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_table4138248135518"></a><a name="en-us_topic_0000001594193229_table4138248135518"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_table4138248135518" frame="border" border="1" rules="all"><caption><b>Table 4 </b>VpnResourceTag</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_p913874812558">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_ul4177729133712"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li1217762923713">Specifies a tag key.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_ul10177112943717"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li1917702915375">Specifies a tag value.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_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_0000001807370468__en-us_topic_0000001594193229_li116612047175615">Example response<pre class="screen" id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_screen678017232489">{
"customer_gateway": {
"id": "03c0aa3d-demo-a8df-va86-9d82473765d4",
"name": "cgw-ba08",
"id_type": "ip",
"id_value": "10.***.***.21",
"bgp_asn": 65000,
"created_at": "2021-12-21T16:49:28.108Z",
"updated_at": "2021-12-21T16:49:28.108Z"
},
"request_id": "8111d315-5024-45c9-8ee3-5ef676edb0d1"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_section31981619"><h4 class="sectiontitle">Status Codes</h4><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_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