forked from docs/doc-exports
Qin Ying, Fan
4a7d4f4cd8
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
187 lines
16 KiB
HTML
187 lines
16 KiB
HTML
<a name="en-dc_topic_0055025323"></a><a name="en-dc_topic_0055025323"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Virtual Gateway List</h1>
|
|
<div id="body1489114536418"><div class="section" id="en-dc_topic_0055025323__section17487184"><h4 class="sectiontitle">Function</h4><p id="en-dc_topic_0055025323__p51221589">This API is used to query the virtual gateway list.</p>
|
|
</div>
|
|
<div class="section" id="en-dc_topic_0055025323__section23166934"><h4 class="sectiontitle">URI</h4><p id="en-dc_topic_0055025323__p111720218480">GET /v2.0/dcaas/virtual-gateways</p>
|
|
</div>
|
|
<div class="section" id="en-dc_topic_0055025323__section64582388"><h4 class="sectiontitle">Request</h4><p id="en-dc_topic_0055025323__p1690513524919"><a href="#en-dc_topic_0055025323__table2198437322244">Table 1</a> lists the request parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-dc_topic_0055025323__table2198437322244"></a><a name="table2198437322244"></a><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025323__table2198437322244" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter</caption><thead align="left"><tr id="en-dc_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-dc_topic_0055025323__p6505580022244"><strong id="en-dc_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-dc_topic_0055025323__p329696222244"><strong id="en-dc_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-dc_topic_0055025323__p3257067222244"><strong id="en-dc_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-dc_topic_0055025323__p5470821922244"><strong id="en-dc_topic_0055025323__b84235270615331">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-dc_topic_0055025323__row5451891922244"><td class="cellrowborder" valign="top" width="17.88178817881788%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-dc_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-dc_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-dc_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-dc_topic_0055025323__p63361141143756">Specifies the parameters expected to be returned.</p>
|
|
<p id="en-dc_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-dc_topic_0055025323__section44370581"><h4 class="sectiontitle">Response</h4><p id="en-dc_topic_0055025323__p17268844145745"><a href="#en-dc_topic_0055025323__table50992744154526">Table 2</a> lists the response parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-dc_topic_0055025323__table50992744154526"></a><a name="table50992744154526"></a><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025323__table50992744154526" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="en-dc_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-dc_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-dc_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-dc_topic_0055025323__p59082508154526">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-dc_topic_0055025323__row20953821154526"><td class="cellrowborder" valign="top" width="23.09%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-dc_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-dc_topic_0055025323__p39071862154526">List data structure</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.32%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-dc_topic_0055025323__p61739489154526">Specifies the virtual gateway list.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025323__table14681450" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of field <strong id="en-dc_topic_0055025323__b8423527069345">virtual_gateways</strong></caption><thead align="left"><tr id="en-dc_topic_0055025323__row21069217"><th align="left" class="cellrowborder" valign="top" width="23.169999999999998%" id="mcps1.3.4.4.2.4.1.1"><p id="en-dc_topic_0055025323__p28885026"><strong id="en-dc_topic_0055025323__b1100486705">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.61%" id="mcps1.3.4.4.2.4.1.2"><p id="en-dc_topic_0055025323__p57985771"><strong id="en-dc_topic_0055025323__b699013364">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.22%" id="mcps1.3.4.4.2.4.1.3"><p id="en-dc_topic_0055025323__p4499576"><strong id="en-dc_topic_0055025323__b1088475532">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-dc_topic_0055025323__row6614602622620"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025323__p4410666095934">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025323__p6119820395934">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025323__p3725148995934">Specifies the virtual gateway ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-dc_topic_0055025323__row4620915422620"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025323__p4142756795934">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025323__p474352395934">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025323__p4213020095934">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-dc_topic_0055025323__row1146602622620"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025323__p1771069495934">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025323__p2802222795934">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025323__p1927422595934">Specifies the virtual gateway name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-dc_topic_0055025323__row2411573022620"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025323__p5772182395934">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025323__p5016039595934">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025323__p3667684995934">Provides supplementary information about the virtual gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-dc_topic_0055025323__row1544898622620"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025323__p2229284495934">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025323__p4585369595934">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025323__p3904531295934">Specifies the ID of the VPC to be accessed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-dc_topic_0055025323__row1078246722620"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025323__p2632726195934">local_ep_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025323__p2826674395934">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025323__p1358305195934">Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-dc_topic_0055025323__row6138324222620"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025323__p6675646995934">device_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025323__p2459927595934">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025323__p6206511595934">Specifies the ID of the physical device used by the virtual gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-dc_topic_0055025323__row1031192022620"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025323__p1704743995934">redundant_device_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025323__p2710879795934">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025323__p6438210695934">Specifies the ID of the redundant physical device used by the virtual gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-dc_topic_0055025323__row29937037142658"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025323__p57549299142715">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025323__p30981615142715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025323__p64741166142715">Specifies the virtual gateway type. The value can be <strong id="en-dc_topic_0055025323__b842352706232310">default</strong> or <strong id="en-dc_topic_0055025323__b842352706232316">double ipsec</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-dc_topic_0055025323__row798712983818"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025323__p16815121703718">bgp_asn</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025323__p78151817113714">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025323__p10815417153713">Specifies the BGP ASN of the virtual gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-dc_topic_0055025323__row25712038104241"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025323__p21235294104244">ipsec_bandwidth</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025323__p42337257104244">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025323__p11156324104244">Specifies the bandwidth provided for IPsec VPN in Mbit/s.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-dc_topic_0055025323__row5093362822620"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025323__p2832203195934">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025323__p4114450195934">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025323__p14681583143836">Specifies the virtual gateway status.</p>
|
|
<p id="en-dc_topic_0055025323__p4594310595934">The value can be <strong id="en-dc_topic_0055025323__b84235270617169">ACTIVE</strong>, <strong id="en-dc_topic_0055025323__b842352706171613">DOWN</strong>, <strong id="en-dc_topic_0055025323__b842352706171618">BUILD</strong>, <strong id="en-dc_topic_0055025323__b842352706171622">ERROR</strong>, <strong id="en-dc_topic_0055025323__b842352706171626">PENDING_CREATE</strong>, <strong id="en-dc_topic_0055025323__b842352706171630">PENDING_UPDATE</strong>, or <strong id="en-dc_topic_0055025323__b842352706171633">PENDING_DELETE</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-dc_topic_0055025323__row1902755522620"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025323__p4615681195934">admin_state_up</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025323__p5200368295934">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025323__p62295959143844">Specifies the administrative status of the virtual gateway.</p>
|
|
<p id="en-dc_topic_0055025323__p5896416595934">The value can be <strong id="en-dc_topic_0055025323__b842352706154840">true</strong> or <strong id="en-dc_topic_0055025323__b842352706154844">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-dc_topic_0055025323__section63790914"><h4 class="sectiontitle">Examples</h4><ul id="en-dc_topic_0055025323__ul47831350111511"><li id="en-dc_topic_0055025323__li77061656195110">Example request<ol id="en-dc_topic_0055025323__ol1480716155216"><li id="en-dc_topic_0055025323__li680719615523">All parameters are returned:</li></ol>
|
|
<pre class="screen" id="en-dc_topic_0055025323__screen138072616529">GET /v2.0/dcaas/virtual-gateways</pre>
|
|
<ol start="2" id="en-dc_topic_0055025323__ol13741161745215"><li id="en-dc_topic_0055025323__li16741201775217">Filtered parameters are returned (for example, the filter is ID):</li></ol>
|
|
<pre class="screen" id="en-dc_topic_0055025323__screen374115177521">GET /v2.0/dcaas/virtual-gateways?id=7ec892f3-ca64-46c7-863f-a2eb1b9e8389</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="en-dc_topic_0055025323__ul5303123214523"><li id="en-dc_topic_0055025323__li10303632145219">Example response<pre class="screen" id="en-dc_topic_0055025323__screen171724018529">{
|
|
"virtual_gateways" : [{
|
|
"id" : "7ec892f3-ca64-46c7-863f-a2eb1b9e8389",
|
|
"tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
|
|
"name" : "virtual gateway1",
|
|
"description" : "",
|
|
"vpc_id" : "908d9cf3-da64-4acb-393f-e5eb6b9e838a",
|
|
"local_ep_group_id" : "f8834cf1-5468-87c7-223d-56e78b9699ab",
|
|
"device_id" : "aaa_01"
|
|
}]
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="en-dc_topic_0055025323__section43233365173224"><h4 class="sectiontitle">Returned Value</h4><p id="en-dc_topic_0055025323__p176816317298">For details, see section <a href="en-dc_topic_0055025342.html">Common Returned Values</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-dc_topic_0055025320.html">Virtual Gateway</a></div>
|
|
</div>
|
|
</div>
|
|
|