forked from docs/doc-exports
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com> Co-authored-by: fanqinying <fanqinying@huawei.com> Co-committed-by: fanqinying <fanqinying@huawei.com>
473 lines
46 KiB
HTML
473 lines
46 KiB
HTML
<a name="ListVirtualGateways"></a><a name="ListVirtualGateways"></a>
|
||
|
||
<h1 class="topictitle1">Querying the Virtual Gateway List</h1>
|
||
<div id="body8662426"><div class="section" id="ListVirtualGateways__en-us_topic_0000001782745617_section42808304288"><h4 class="sectiontitle">Function</h4><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1128153092815">This API is used to query the virtual gateway list.</p>
|
||
</div>
|
||
<div class="section" id="ListVirtualGateways__en-us_topic_0000001782745617_section428163042814"><h4 class="sectiontitle">URI</h4><p id="ListVirtualGateways__en-us_topic_0000001782745617_p3281163018284">GET /v3/{project_id}/dcaas/virtual-gateways</p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListVirtualGateways__en-us_topic_0000001782745617_table122821730122814" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="ListVirtualGateways__en-us_topic_0000001782745617_row122821030142816"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p10283153020285">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p6283153015287">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p8284173092811">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p7284113018282">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ListVirtualGateways__en-us_topic_0000001782745617_row1328233052819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p192841830172815">project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p328403062814">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p102851230192817">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1828563013289">Specifies the project ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListVirtualGateways__en-us_topic_0000001782745617_table6287430132810" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="ListVirtualGateways__en-us_topic_0000001782745617_row928619309283"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p13288130102820">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1628815307283">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p112882309283">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p11289630182813">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ListVirtualGateways__en-us_topic_0000001782745617_row8286103016280"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p4289193092814">limit</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p42890305285">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p22892301280">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p028915309285">Specifies the number of records returned on each page. Value range: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b136943598410">1–2000</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p11290430192811">Minimum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b13341513131711">1</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p1329013305285">Maximum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b1833471316170">2000</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p5290173016284">Default: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b163341913141710">2000</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row20286130162818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p182901730192818">marker</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p17290430172818">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p102912304288">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p6291430122816">Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b209941932134519">limit</strong>.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p92911830102811">Minimum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b7335513161713">0</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p8291330122811">Maximum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b16335613141719">36</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row1028619303284"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p529119306282">fields</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1129215305284">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p13292193015286">Array</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p10292183013285">Specifies the list of fields to be displayed.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p142928308283">Array length: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b10337111310174">1–5</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row11286103014285"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p132921330112812">sort_dir</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p22931630122815">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1829363018282">Array</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p17293123018287">Specifies the sorting order of returned results, which can be <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b976911255614">asc</strong> (ascending order) or <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b47695252611">desc</strong> (descending order). The default value is <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b976913251061">asc</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row228743052818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p429373013282">sort_key</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p12294133018289">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p152941530192815">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p5294153018284">Specifies the field for sorting.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p15294173072814">Default: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b113398132179">id</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p15294113082811">Minimum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b12339713181712">0</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p14295193018284">Maximum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b7340513131710">36</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row9287830102814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p2295123013286">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p122951730162814">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p32951330112820">Array</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p829523011287">Specifies the resource ID by which instances are queried.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p112963308288">Array length: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b15341101310173">1–5</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row192871830162817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1029633042813">enterprise_project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p162966307282">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p429617307283">Array</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p129713306283">Filters resource instances by enterprise project ID.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p112977302288">Array length: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b1734211310178">1–10</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row1287103022811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p72971830152811">vpc_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p729763042817">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p329710308284">Array</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1429883092819">Specifies the VPC ID by which virtual gateways are queried.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="ListVirtualGateways__en-us_topic_0000001782745617_section10298230202815"><h4 class="sectiontitle">Request Parameters</h4>
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListVirtualGateways__en-us_topic_0000001782745617_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListVirtualGateways__en-us_topic_0000001782745617_row1129843018286"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p2299163016281">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1729963017286">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p930083014282">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p0300330182813">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ListVirtualGateways__en-us_topic_0000001782745617_row112987309288"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p16300530162819">X-Auth-Token</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p123001230142816">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p330173018289">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p16301173017280">Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the <em id="ListVirtualGateways__en-us_topic_0000001782745617_i5348191381711">Identity and Access Management API Reference</em>. The token is the value of <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b19348151361714">X-Subject-Token</strong> in the response header.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p33013300280">Minimum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b1807149928">0</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p2030173002814">Maximum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b434814134174">10240</strong></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="ListVirtualGateways__en-us_topic_0000001782745617_section930133011287"><h4 class="sectiontitle">Response Parameters</h4><p id="ListVirtualGateways__en-us_topic_0000001782745617_p203025302284"><strong id="ListVirtualGateways__en-us_topic_0000001782745617_b173487131174">Status code: 200</strong></p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListVirtualGateways__en-us_topic_0000001782745617_response_ListVirtualGatewaysResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListVirtualGateways__en-us_topic_0000001782745617_row143021030172819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p133037301285">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p17303430172813">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p5303173042812">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ListVirtualGateways__en-us_topic_0000001782745617_row1730218304285"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p143046302281">request_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1330411306284">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1230411302288">Specifies the request ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row9302113016283"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1330433022811">virtual_gateways</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p13305330132818">Array of <a href="#ListVirtualGateways__en-us_topic_0000001782745617_response_VirtualGateway">VirtualGateway</a> objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p830563092816">Specifies the virtual gateway list.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row1430203022812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p2305130202817">page_info</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1530533022816"><a href="#ListVirtualGateways__en-us_topic_0000001782745617_response_PageInfo">PageInfo</a> object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p143068304283">Specifies the pagination query information.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ListVirtualGateways__en-us_topic_0000001782745617_response_VirtualGateway"></a><a name="en-us_topic_0000001782745617_response_VirtualGateway"></a><table cellpadding="4" cellspacing="0" summary="" id="ListVirtualGateways__en-us_topic_0000001782745617_response_VirtualGateway" frame="border" border="1" rules="all"><caption><b>Table 5 </b>VirtualGateway</caption><thead align="left"><tr id="ListVirtualGateways__en-us_topic_0000001782745617_row103071030172811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p8309103012813">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p203103301286">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p33101330102812">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ListVirtualGateways__en-us_topic_0000001782745617_row1930773072817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p20310030182817">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p193104306289">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p17311173022811">Specifies the virtual gateway ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row133071830152811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p03117309287">vpc_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p11311930132813">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p143111030132818">Specifies the ID of the VPC connected using the virtual gateway.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row3307103072812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p173111430112814">enterprise_router_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p231283072811">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p731243019285">Specifies the ID of the enterprise router that the virtual gateway is attached to.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row530712302285"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p11312113012282">tenant_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p5313123002819">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p11313130122817">Specifies the project ID.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p143131930202812">Minimum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b1136011341715">32</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p15313163012287">Maximum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b1136071321715">32</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row1930713304282"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1431373092818">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p13314123012810">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p63141930112815">Specifies the virtual gateway name.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p1931420308281">Minimum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b936210136173">0</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p731413072817">Maximum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b336291316171">64</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row18308230112820"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p23141130172813">description</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p203152030182818">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1331513022820">Provides supplementary information about the virtual gateway.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p1315173014281">Minimum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b93631113141714">0</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p183158303288">Maximum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b23631013141711">128</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row530823014284"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p173159309284">type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1831613042815">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p19316133062812">Specifies the virtual gateway type. The value can only be <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b19364913171712">default</strong>.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p131616303283">Default: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b1336411136172">default</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row18308530112811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p631613012282">local_ep_group</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1131753016287">Array of strings</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p331717300283">Specifies the IPv4 subnets of the associated VPC that can be accessed over the virtual gateway.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row1730813014287"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p16317430192812">local_ep_group_ipv6</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p33171330122811">Array of strings</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p123181030122820">Specifies the IPv6 subnets of the associated VPC that can be accessed over the virtual gateway. This is a reserved field.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row1130883018287"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p931863012812">admin_state_up</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p831813012285">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p53181730172811">Specifies the administrative status. The value can be <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b1336761391720">true</strong> or <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b16367121341714">false</strong>.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p031843010281">Default: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b736781319176">true</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row9308163010283"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p18319183092812">status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1531911300280">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p531973018289">Specifies the operating status. The value can be <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b19368913151716">ACTIVE</strong>, <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b736819130172">DOWN</strong>, <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b4368191312171">BUILD</strong>, <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b10368513121719">ERROR</strong>, <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b113684132175">PENDING_CREATE</strong>, <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b2368613181717">PENDING_UPDATE</strong>, or <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b6368181311717">PENDING_DELETE</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row19308930182817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p6319153013282">bgp_asn</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p14320123015283">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p17320193015283">Specifies the local BGP ASN of the virtual gateway.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p17320430142817">Minimum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b163698132175">1</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p11320143013282">Maximum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b2369151311719">4294967295</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row8308103016281"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p13320183032814">enterprise_project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p17321133092811">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p193212030132820">Specifies the ID of the enterprise project that the virtual gateway belongs to.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p1832103092816">Minimum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b20370913191719">36</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p193211930192811">Maximum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b7371613121718">36</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row203081130152817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p10321143010287">device_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p173221730102814">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1132293002816">Specifies the ID of the device that the virtual interface belongs to.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row1030813014288"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p9322123052811">redundant_device_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p33222302285">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p93223300285">Specifies the ID of the redundant device.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row530814302282"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p2323113022814">public_border_group</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p1232303017283">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p13323173022812">Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. (This parameter is not supported currently.)</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row930813306281"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p11323183092814">tags</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p532443032816">Array of <a href="#ListVirtualGateways__en-us_topic_0000001782745617_response_Tag">Tag</a> objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p11324143032818">Specifies the tags.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p103240302288">Array length: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b994615011711">0–10</strong></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ListVirtualGateways__en-us_topic_0000001782745617_response_Tag"></a><a name="en-us_topic_0000001782745617_response_Tag"></a><table cellpadding="4" cellspacing="0" summary="" id="ListVirtualGateways__en-us_topic_0000001782745617_response_Tag" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Tag</caption><thead align="left"><tr id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_row386111195349"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_p71389204345">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_p113892053413">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_p19138320103413">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_row68621619203416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_p1313811204343">key</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_p6138132013342">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><div class="p" id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_p988813512470">Specifies the tag key. The key:<ul id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_ul161904329534"><li id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_li19190153219534">Cannot be left blank.</li><li id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_li7190432145319">Must be unique for each resource.</li><li id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_li181905324537">Can contain a maximum of 36 Unicode characters.</li><li id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_li1219019324535">Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).</li></ul>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_row78621819123417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_p2138122003420">value</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_p8138182073414">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><div class="p" id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_p422514116535">Specifies the tag value. The value:<ul id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_ul15189353205316"><li id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_li51898538530">Can be left blank.</li><li id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_li16189195355312">Can contain a maximum of 43 Unicode characters.</li><li id="ListVirtualGateways__en-us_topic_0000001782745617_en-us_topic_0000001735825404_li181891853115318">Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).</li></ul>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ListVirtualGateways__en-us_topic_0000001782745617_response_PageInfo"></a><a name="en-us_topic_0000001782745617_response_PageInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListVirtualGateways__en-us_topic_0000001782745617_response_PageInfo" frame="border" border="1" rules="all"><caption><b>Table 7 </b>PageInfo</caption><thead align="left"><tr id="ListVirtualGateways__en-us_topic_0000001782745617_row332983014286"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p333018308287">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p18331103042812">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p93311130192815">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ListVirtualGateways__en-us_topic_0000001782745617_row93291930172819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p7331123092818">previous_marker</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p933253022817">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p5332133022815">Specifies the marker of the previous page. The value is the resource UUID.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p10332230152817">Minimum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b16382613191716">0</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p03322030102812">Maximum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b1738281319176">36</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row5329103032810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p103325302285">current_count</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p12333830182811">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p633333016283">Specifies the number of resources in the current list.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p23331230102817">Minimum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b1538317137177">0</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p8333193032811">Maximum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b143841133178">2000</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ListVirtualGateways__en-us_topic_0000001782745617_row1433013303289"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p73342307282">next_marker</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p153341430132820">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p533443020283">Specifies the marker of the next page. The value is the resource UUID. If this parameter is left empty, the resource is on the last page.</p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p933493012820">Minimum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b13851113191711">0</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p1433417301285">Maximum: <strong id="ListVirtualGateways__en-us_topic_0000001782745617_b3385171331710">36</strong></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="ListVirtualGateways__en-us_topic_0000001782745617_section1233519309286"><h4 class="sectiontitle">Example Requests</h4><p id="ListVirtualGateways__en-us_topic_0000001782745617_p17740163016281">Querying the virtual gateway list</p>
|
||
<pre class="screen" id="ListVirtualGateways__en-us_topic_0000001782745617_screen1974033010282">GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways</pre>
|
||
</div>
|
||
<div class="section" id="ListVirtualGateways__en-us_topic_0000001782745617_section87407301284"><h4 class="sectiontitle">Example Responses</h4><p id="ListVirtualGateways__en-us_topic_0000001782745617_p177401130192819"><strong id="ListVirtualGateways__en-us_topic_0000001782745617_b950251312179">Status code: 200</strong></p>
|
||
<p id="ListVirtualGateways__en-us_topic_0000001782745617_p87401230132814">OK</p>
|
||
<ul id="ListVirtualGateways__en-us_topic_0000001782745617_ul0740143016283"><li id="ListVirtualGateways__en-us_topic_0000001782745617_li2074012309286">The list of virtual gateways associated with VPCs is queried.<pre class="screen" id="ListVirtualGateways__en-us_topic_0000001782745617_screen15740113013287">{
|
||
"virtual_gateways" : [ {
|
||
"id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
|
||
"name" : "vgw-c7b22",
|
||
"description" : "",
|
||
"tenant_id" : "0605768a3300d5762f82c01180692873",
|
||
"vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
|
||
"tags": [],
|
||
"device_id" : "26.151.63.100",
|
||
"redundant_device_id" : "26.152.128.20",
|
||
"type" : "default",
|
||
"status" : "ACTIVE",
|
||
"admin_state_up" : true,
|
||
"bgp_asn" : 64512,
|
||
"local_ep_group" : [ "192.168.1.0/24" ],
|
||
"enterprise_project_id" : "0",
|
||
"public_border_group" : "center"
|
||
} ],
|
||
"request_id" : "765f7aaf8f2edd0e719de564ef72e2de"
|
||
}</pre>
|
||
</li><li id="ListVirtualGateways__en-us_topic_0000001782745617_li8741103072816">The list of virtual gateways attached to enterprise routers is queried.<pre class="screen" id="ListVirtualGateways__en-us_topic_0000001782745617_screen67411230182811">{
|
||
"virtual_gateways" : [ {
|
||
"name" : "vgw-er",
|
||
"id" : "7a91797a-cbda-42ff-9f42-73f26c993dd9",
|
||
"description" : "",
|
||
"tenant_id" : "92ea72fe26294aa180a2712c28e43c21",
|
||
"vpc_id" : null,
|
||
"enterprise_router_id" : "61fa53c9-4446-4ebd-89b9-11a52b653a9c",
|
||
"tags": [],
|
||
"device_id" : "26.151.63.100",
|
||
"redundant_device_id" : "26.152.128.20",
|
||
"type" : "default",
|
||
"status" : "ACTIVE",
|
||
"admin_state_up" : true,
|
||
"bgp_asn" : 64512,
|
||
"local_ep_group" : null,
|
||
"local_ep_group_ipv6" : null,
|
||
"public_border_group" : null
|
||
} ],
|
||
"request_id" : "765f7aaf8f2edd0e719de564e6174dfa"
|
||
}</pre>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="ListVirtualGateways__en-us_topic_0000001782745617_section374515301288"><h4 class="sectiontitle">Status Codes</h4>
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListVirtualGateways__en-us_topic_0000001782745617_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListVirtualGateways__en-us_topic_0000001782745617_row63572309285"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p47451130102813">Status Code</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListVirtualGateways__en-us_topic_0000001782745617_p57451030112820">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ListVirtualGateways__en-us_topic_0000001782745617_row11357130152813"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p374523019286">200</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListVirtualGateways__en-us_topic_0000001782745617_p674503022813">OK</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="ListVirtualGateways__en-us_topic_0000001782745617_section1874517307283"><h4 class="sectiontitle">Error Codes</h4><p id="ListVirtualGateways__en-us_topic_0000001782745617_p874543022810">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
||
</div>
|
||
</div>
|
||
<div>
|
||
<div class="familylinks">
|
||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">Virtual Gateways</a></div>
|
||
</div>
|
||
</div>
|
||
|