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

284 lines
32 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001854169145"></a><a name="EN-US_TOPIC_0000001854169145"></a>
<h1 class="topictitle1">Querying the Customer Gateway List</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_section129849566244"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p1487610174615">This API is used to query the customer gateway list.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_section18104173342818"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p38265365328">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_0000001854169145__en-us_topic_0000001543354000_section4984185613243"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p36235140505">GET /v5/{project_id}/customer-gateways</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_table3672032" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_p179611479215">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.798820117988202%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p18759866">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.555144485551445%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p43154149">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row5825185"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_p177965479212">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.798820117988202%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p34098154">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.555144485551445%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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 class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_table65436" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter in a query request</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row891882310111"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p2919192312115">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p291962320118">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p16919162315113">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p59192023611">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row16918122319110"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p1892014231414">limit</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p209206233113">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p18920132313115">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul12256122111619"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li12256192117612">Specifies the number of records returned on each page during pagination query.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li198991840162">The value ranges from 0 to 200.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li17256221369">The default value is 200.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row991832314110"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p139214239117">marker</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p292117237112">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p49211323813">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul471410271073"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li157141327871">Specifies the start flag for querying the current page. If this parameter is left blank, the first page is queried. The <strong id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_b216017311709">marker</strong> for querying the next page is the <strong id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_b15160631908">next_marker</strong> in the <strong id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_b11603311601">page_info</strong> object returned on the current page.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li11300164817712">This parameter must be used together with <strong id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_b20437331708">limit</strong>.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_section209842056172413"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul11984145614240"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li104251491316">Request parameters<p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p1274419481317"><a name="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li104251491316"></a><a name="en-us_topic_0000001543354000_li104251491316"></a>None</p>
</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li13423212570">Example request<pre class="screen" id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_screen898418561243">GET https://{Endpoint}/v5/{project_id}/customer-gateways?limit={limit}&amp;marker={marker}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_section139846564245"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul3984556122414"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li1898417568243">Response parameters<p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p1592416239112"><a name="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li1898417568243"></a><a name="en-us_topic_0000001543354000_li1898417568243"></a>Returned status code 200: successful query</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_table92209" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the response body</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row11129162615289"><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_0000001854169145__en-us_topic_0000001543354000_p20130182662816">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p10130826102819">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p513072692815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row121291326162820"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p4130152682820">customer_gateways</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p1113142619280">Array of</p>
<p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p88853642010"><a href="#EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_table92210">ResponseCustomerGateway</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p20131826152820">Specifies the customer gateway object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row512912682814"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p61311326132819">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p81311326122814">Long</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p15132122620286">Specifies the total number of a tenant's customer gateways.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row1412992632812"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p17132152622817">page_info</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p513222617282"><a href="#EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_table92211">PageInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p4132726132815">Specifies pagination information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row121298263288"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p1313262615285">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p713392652818">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p213342617285">Specifies a request ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_table92210"></a><a name="en-us_topic_0000001543354000_table92210"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_table92210" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ResponseCustomerGateway</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row913382614283"><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_0000001854169145__en-us_topic_0000001543354000_p18134226112811">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_0000001854169145__en-us_topic_0000001543354000_p0134726152816">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_0000001854169145__en-us_topic_0000001543354000_p1313512260282">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row3133926162820"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_ul4510103818305"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li156736439303">Specifies a customer gateway ID.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li1525265511233">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row813342616288"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_ul4955105118115"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li7955551161115">Specifies a customer gateway name. If no customer gateway name is specified, the system automatically generates one.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_row108151827195517"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_ul192612345211"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li2266317525">Specifies the identifier type of a customer gateway.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li183961224204311">Value range:<ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul191973212436"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li2604152816439">ip</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li122673135214">fqdn (currently not supported)</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row1888482595512"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_p1685712819529">Specifies the identifier of a customer gateway.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row8133026152810"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_p179561588484">Specifies the BGP AS number of the customer gateway. This parameter is available only when <strong id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_b1426393681210">id_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_b1626303613125">ip</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row201346268287"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_ul133112028172316"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li13781131142310">Specifies the time when the customer gateway is created.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li153111528132315">The UTC time format is <em id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_i120956133733927">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row1013412616288"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_ul6106151392213"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li7781631182313">Specifies the last update time.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li1277785732017">The UTC time format is <em id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_i26456225933927">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row18723192919393"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_p147855259548">Array of <a href="#EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_p1280042717591">Specifies a tag list.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row1464561434812"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_ul1579159184914"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li357912596498">Specifies the routing mode.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li557995918499">Value range:<p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p0822043105010"><a name="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li557995918499"></a><a name="en-us_topic_0000001543354000_li557995918499"></a><strong id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_b420412013176">static</strong>: static routing mode</p>
<p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p182284315013"><strong id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_b105361936171">bgp</strong>: BGP routing mode</p>
<p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_row1492511614481"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_ul57421722105011"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li7742162205010">Specifies the IP address of the customer gateway.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li574292217508">The value is an IPv4 address, for example, 10.***.***.21.<p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p182991511105111"><a name="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li574292217508"></a><a name="en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_table4138248135518"></a><a name="en-us_topic_0000001543354000_table4138248135518"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_table4138248135518" frame="border" border="1" rules="all"><caption><b>Table 5 </b>VpnResourceTag</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_p913874812558">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_ul4177729133712"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li1217762923713">Specifies a tag key.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_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_0000001854169145__en-us_topic_0000001543354000_ul10177112943717"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li1917702915375">Specifies a tag value.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_table92211"></a><a name="en-us_topic_0000001543354000_table92211"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_table92211" frame="border" border="1" rules="all"><caption><b>Table 6 </b>PageInfo</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row1014392612818"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.5.2.4.1.1"><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p18143192616289">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.5.2.4.1.2"><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p1714310263288">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.5.2.4.1.3"><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p31441526172815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row51432261280"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p1814432612816">next_marker</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p8144102610285">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p131441326122812">Specifies the marker of the next page. The value is the time when the last resource in the last query response was created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row314332662817"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p121441426152811">current_count</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p9145112642811">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p14145142682820">Specifies the number of resources in the list. If the value of <strong id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_b35452420019">current_count</strong> is less than the value of <strong id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_b854514421012">limit</strong> in the query request, the current page is the last page.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li32691116145717">Example response<pre class="screen" id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_screen678017232489">{
"customer_gateways": [{
"id": "e67d6e27-demo-a8df-va86-be9a0f0168e9",
"name": "cgw-a45b",
"id_type": "ip",
"id_value": "100.***.***.81",
"bgp_asn": 65588,
"created_at": "2022-11-28T07:36:24.923Z",
"updated_at": "2022-11-28T07:36:24.923Z"
}, {
"id": "312067bb-demo-a8df-va86-09dc941bbffc",
"name": "cgw-21a3",
"id_value": "123******456",
"created_at": "2022-11-28T06:25:01.937Z",
"updated_at": "2022-11-28T06:25:01.937Z"
}],
"total_count": 2,
"page_info": {
"next_marker": "2022-11-28T06:25:01.937Z",
"current_count": 2
},
"request_id": "82a108d9-0929-42e9-adb7-e146c04c587c"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_section198516561248"><h4 class="sectiontitle">Status Codes</h4><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_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