forked from docs/doc-exports
Qin Ying, Fan
62ab8a5fe2
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
91 lines
7.1 KiB
HTML
91 lines
7.1 KiB
HTML
<a name="en-us_topic_0055025323"></a><a name="en-us_topic_0055025323"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Virtual Gateway List</h1>
|
|
<div id="body1489114536418"><div class="section" id="en-us_topic_0055025323__section17487184"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0055025323__p51221589">This API is used to query the virtual gateway list.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025323__section23166934"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0055025323__p111720218480">GET /v2.0/dcaas/virtual-gateways</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025323__section64582388"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0055025323__p1690513524919"><a href="#en-us_topic_0055025323__table2198437322244">Table 1</a> lists the request parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025323__table2198437322244"></a><a name="table2198437322244"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025323__table2198437322244" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter</caption><thead align="left"><tr id="en-us_topic_0055025323__row4304807922244"><th align="left" class="cellrowborder" valign="top" width="17.88178817881788%" id="mcps1.3.3.3.2.5.1.1"><p id="en-us_topic_0055025323__p6505580022244"><strong id="en-us_topic_0055025323__b8423527069918">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.43164316431643%" id="mcps1.3.3.3.2.5.1.2"><p id="en-us_topic_0055025323__p329696222244"><strong id="en-us_topic_0055025323__b842352706165439">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.94179417941794%" id="mcps1.3.3.3.2.5.1.3"><p id="en-us_topic_0055025323__p3257067222244"><strong id="en-us_topic_0055025323__b842352706192549">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.74477447744774%" id="mcps1.3.3.3.2.5.1.4"><p id="en-us_topic_0055025323__p5470821922244"><strong id="en-us_topic_0055025323__b84235270615331">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025323__row5451891922244"><td class="cellrowborder" valign="top" width="17.88178817881788%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-us_topic_0055025323__p6157819622316">fields</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.43164316431643%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en-us_topic_0055025323__p757920222316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.94179417941794%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en-us_topic_0055025323__p4706384922316">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.74477447744774%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en-us_topic_0055025323__p63361141143756">Specifies the parameters expected to be returned.</p>
|
|
<p id="en-us_topic_0055025323__p970883222316">If you do not specify it, all parameters will be returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025323__section44370581"><a name="en-us_topic_0055025323__section44370581"></a><a name="section44370581"></a><h4 class="sectiontitle">Response</h4><p id="en-us_topic_0055025323__p17268844145745"><a href="#en-us_topic_0055025323__table50992744154526">Table 2</a> lists the response parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025323__table50992744154526"></a><a name="table50992744154526"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025323__table50992744154526" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="en-us_topic_0055025323__row20073554154526"><th align="left" class="cellrowborder" valign="top" width="23.09%" id="mcps1.3.4.3.2.4.1.1"><p id="en-us_topic_0055025323__p15345186154526">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.590000000000003%" id="mcps1.3.4.3.2.4.1.2"><p id="en-us_topic_0055025323__p35000534154526">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.32%" id="mcps1.3.4.3.2.4.1.3"><p id="en-us_topic_0055025323__p59082508154526">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025323__row20953821154526"><td class="cellrowborder" valign="top" width="23.09%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025323__p19537972154526">virtual_gateways</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.590000000000003%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025323__p39071862154526">List</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.32%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025323__p61739489154526">Specifies the virtual gateway list.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="en-us_topic_0055025323__p189571391395">For details about the <strong id="en-us_topic_0055025323__b20186656030">virtual_gateway</strong> field, see <a href="en-us_topic_0055025321.html#en-us_topic_0055025321__en-us_topic_0070676570_table49902238182444">Table 1</a>.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025323__section63790914"><a name="en-us_topic_0055025323__section63790914"></a><a name="section63790914"></a><h4 class="sectiontitle">Examples</h4><ul id="en-us_topic_0055025323__ul47831350111511"><li id="en-us_topic_0055025323__li77061656195110">Example request<ol id="en-us_topic_0055025323__ol1480716155216"><li id="en-us_topic_0055025323__li680719615523">Querying all virtual gateways</li></ol>
|
|
<pre class="screen" id="en-us_topic_0055025323__screen138072616529">GET /v2.0/dcaas/virtual-gateways</pre>
|
|
<ol start="2" id="en-us_topic_0055025323__ol13741161745215"><li id="en-us_topic_0055025323__li16741201775217">Querying a virtual gateway by ID</li></ol>
|
|
<pre class="screen" id="en-us_topic_0055025323__screen374115177521">GET /v2.0/dcaas/virtual-gateways?id=7ec892f3-ca64-46c7-863f-a2eb1b9e8389</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="en-us_topic_0055025323__ul5303123214523"><li id="en-us_topic_0055025323__li10303632145219">Example response<pre class="screen" id="en-us_topic_0055025323__screen171724018529">{
|
|
"virtual_gateways" : [{
|
|
"id": "0a0888a6-4096-43a6-81c6-923912933451",
|
|
"name": "virtual gateway",
|
|
"description": null,
|
|
"tenant_id": "0605768a3300d5762f82c01180692873",
|
|
"vpc_id": "5352423b-b4ff-4a9e-839d-02698c2b36af",
|
|
"local_ep_group_id": "f8834cf1-5468-87c7-223d-56e78b9699ab",
|
|
"local_ep_group_ipv6_id": null,
|
|
"device_id": "aaa_01",
|
|
"redundant_device_id": null,
|
|
"type": "default",
|
|
"ipsec_bandwidth": 1,
|
|
"status": "PENDING_CREATE",
|
|
"admin_state_up": true,
|
|
"bgp_asn": 64512,
|
|
"region_id": null
|
|
}]
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="en-us_topic_0055025323__section43233365173224"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0055025323__p176816317298">For details, see <a href="en-us_topic_0055025342.html">Common Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0055025320.html">Virtual Gateway</a></div>
|
|
</div>
|
|
</div>
|
|
|