doc-exports/docs/dc/api-ref/en-dc_topic_0055025326.html
Qin Ying, Fan 4a7d4f4cd8 DC API 0930 version
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>
2022-10-06 09:33:01 +00:00

255 lines
20 KiB
HTML

<a name="en-dc_topic_0055025326"></a><a name="en-dc_topic_0055025326"></a>
<h1 class="topictitle1">Updating a Virtual Gateway</h1>
<div id="body1489114536418"><div class="section" id="en-dc_topic_0055025326__section10267951"><h4 class="sectiontitle">Function</h4><p id="en-dc_topic_0055025326__p15526968">This API is used to update a virtual gateway.</p>
</div>
<div class="section" id="en-dc_topic_0055025326__section25302698"><h4 class="sectiontitle">URI</h4><p id="en-dc_topic_0055025326__p1593711711268">PUT /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025326__table78013327231" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-dc_topic_0055025326__row128753217231"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.2.3.2.5.1.1"><p id="en-dc_topic_0055025326__p1587432182316">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.42785721427857%" id="mcps1.3.2.3.2.5.1.2"><p id="en-dc_topic_0055025326__p1694123232312"><strong id="en-dc_topic_0055025326__b842352706165439">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.328367163283673%" id="mcps1.3.2.3.2.5.1.3"><p id="en-dc_topic_0055025326__p894632182312"><strong id="en-dc_topic_0055025326__b842352706192549">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.85571442855714%" id="mcps1.3.2.3.2.5.1.4"><p id="en-dc_topic_0055025326__p7941332152315"><strong id="en-dc_topic_0055025326__b84235270615331">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025326__row1994932152311"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en-dc_topic_0055025326__p1594203215232">virtual_gateway_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en-dc_topic_0055025326__p794173252315">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en-dc_topic_0055025326__p2103173217239">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="42.85571442855714%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en-dc_topic_0055025326__p010343252316">Specifies the virtual gateway ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025326__section36252627"><h4 class="sectiontitle">Request</h4><p id="en-dc_topic_0055025326__p21078426103641"><a href="#en-dc_topic_0055025326__table50992744154526">Table 2</a> lists the request parameter.</p>
<div class="tablenoborder"><a name="en-dc_topic_0055025326__table50992744154526"></a><a name="table50992744154526"></a><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025326__table50992744154526" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="en-dc_topic_0055025326__row20073554154526"><th align="left" class="cellrowborder" valign="top" width="22.3%" id="mcps1.3.3.3.2.5.1.1"><p id="en-dc_topic_0055025326__p15345186154526">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.62%" id="mcps1.3.3.3.2.5.1.2"><p id="en-dc_topic_0055025326__p35000534154526"><strong id="en-dc_topic_0055025326__b2832396">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.45%" id="mcps1.3.3.3.2.5.1.3"><p id="en-dc_topic_0055025326__p16470999154526"><strong id="en-dc_topic_0055025326__b1167039233">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.63%" id="mcps1.3.3.3.2.5.1.4"><p id="en-dc_topic_0055025326__p59082508154526">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025326__row20953821154526"><td class="cellrowborder" valign="top" width="22.3%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-dc_topic_0055025326__p19537972154526">virtual_gateway</p>
</td>
<td class="cellrowborder" valign="top" width="18.62%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en-dc_topic_0055025326__p39071862154526">Dictionary data structure</p>
</td>
<td class="cellrowborder" valign="top" width="17.45%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en-dc_topic_0055025326__p10704269154526">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="41.63%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en-dc_topic_0055025326__p61739489154526">Specifies the <strong id="en-dc_topic_0055025326__b842352706191940">virtual_gateway</strong> object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="en-dc_topic_0055025326__p5712311614534"></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025326__table125648759846" frame="border" border="1" rules="all"><thead align="left"><tr id="en-dc_topic_0055025326__row265942339846"><th align="left" class="cellrowborder" valign="top" width="25.21%" id="mcps1.3.3.5.1.5.1.1"><p id="en-dc_topic_0055025326__p351661709915"><strong id="en-dc_topic_0055025326__b8423527069918">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.469999999999999%" id="mcps1.3.3.5.1.5.1.2"><p id="en-dc_topic_0055025326__p89913189915"><strong id="en-dc_topic_0055025326__b984023522">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.02%" id="mcps1.3.3.5.1.5.1.3"><p id="en-dc_topic_0055025326__p209180099915"><strong id="en-dc_topic_0055025326__b593730220">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.300000000000004%" id="mcps1.3.3.5.1.5.1.4"><p id="en-dc_topic_0055025326__p132751689915"><strong id="en-dc_topic_0055025326__b539261572">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025326__row66033117145224"><td class="cellrowborder" valign="top" width="25.21%" headers="mcps1.3.3.5.1.5.1.1 "><p id="en-dc_topic_0055025326__p15341960145224">description</p>
</td>
<td class="cellrowborder" valign="top" width="11.469999999999999%" headers="mcps1.3.3.5.1.5.1.2 "><p id="en-dc_topic_0055025326__p34739281145224">String</p>
</td>
<td class="cellrowborder" valign="top" width="18.02%" headers="mcps1.3.3.5.1.5.1.3 "><p id="en-dc_topic_0055025326__p62418382145224">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.300000000000004%" headers="mcps1.3.3.5.1.5.1.4 "><p id="en-dc_topic_0055025326__p22724200145224">Provides supplementary information about the virtual gateway.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025326__row52076255145224"><td class="cellrowborder" valign="top" width="25.21%" headers="mcps1.3.3.5.1.5.1.1 "><p id="en-dc_topic_0055025326__p57161530145224">name</p>
</td>
<td class="cellrowborder" valign="top" width="11.469999999999999%" headers="mcps1.3.3.5.1.5.1.2 "><p id="en-dc_topic_0055025326__p66681242145224">String</p>
</td>
<td class="cellrowborder" valign="top" width="18.02%" headers="mcps1.3.3.5.1.5.1.3 "><p id="en-dc_topic_0055025326__p32471539145224">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.300000000000004%" headers="mcps1.3.3.5.1.5.1.4 "><p id="en-dc_topic_0055025326__p12948972145224">Specifies the virtual gateway name.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025326__row22650581145251"><td class="cellrowborder" valign="top" width="25.21%" headers="mcps1.3.3.5.1.5.1.1 "><p id="en-dc_topic_0055025326__p38440998145251">local_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.469999999999999%" headers="mcps1.3.3.5.1.5.1.2 "><p id="en-dc_topic_0055025326__p26713113145251">String</p>
</td>
<td class="cellrowborder" valign="top" width="18.02%" headers="mcps1.3.3.5.1.5.1.3 "><p id="en-dc_topic_0055025326__p16278516145251">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.300000000000004%" headers="mcps1.3.3.5.1.5.1.4 "><p id="en-dc_topic_0055025326__p43491424145251">Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025326__section57838187"><h4 class="sectiontitle">Response</h4><p id="en-dc_topic_0055025326__p17268844145745"><a href="#en-dc_topic_0055025326__table4284712915501">Table 3</a> lists the response parameter.</p>
<div class="tablenoborder"><a name="en-dc_topic_0055025326__table4284712915501"></a><a name="table4284712915501"></a><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025326__table4284712915501" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter</caption><thead align="left"><tr id="en-dc_topic_0055025326__row4552452315501"><th align="left" class="cellrowborder" valign="top" width="31%" id="mcps1.3.4.3.2.4.1.1"><p id="en-dc_topic_0055025326__p6360776715501">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27%" id="mcps1.3.4.3.2.4.1.2"><p id="en-dc_topic_0055025326__p5195553615501">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42%" id="mcps1.3.4.3.2.4.1.3"><p id="en-dc_topic_0055025326__p3435514315501">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025326__row3130318915501"><td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-dc_topic_0055025326__p5253038415501">virtual_gateway</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-dc_topic_0055025326__p2710268715501">Dictionary data structure</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-dc_topic_0055025326__p4935093915501">Specifies the <strong id="en-dc_topic_0055025326__b842352706192031">virtual_gateway</strong> object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="en-dc_topic_0055025326__p35884518145745">Description of field <strong id="en-dc_topic_0055025326__b8423527069345">virtual_gateway</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025326__table49261880" frame="border" border="1" rules="all"><thead align="left"><tr id="en-dc_topic_0055025326__row31386613"><th align="left" class="cellrowborder" valign="top" width="32%" id="mcps1.3.4.5.1.4.1.1"><p id="en-dc_topic_0055025326__p59287744"><strong id="en-dc_topic_0055025326__b1963068294">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.1.4.1.2"><p id="en-dc_topic_0055025326__p37577972"><strong id="en-dc_topic_0055025326__b436603854">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43%" id="mcps1.3.4.5.1.4.1.3"><p id="en-dc_topic_0055025326__p58217140"><strong id="en-dc_topic_0055025326__b1086314411">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025326__row22166934145242"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.1.4.1.1 "><p id="en-dc_topic_0055025326__p14291132145242">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.1.4.1.2 "><p id="en-dc_topic_0055025326__p16731007145242">String</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.4.5.1.4.1.3 "><p id="en-dc_topic_0055025326__p49150553145242">Specifies the virtual gateway ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025326__row9919533145242"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.1.4.1.1 "><p id="en-dc_topic_0055025326__p61728820145242">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.1.4.1.2 "><p id="en-dc_topic_0055025326__p33978489145242">String</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.4.5.1.4.1.3 "><p id="en-dc_topic_0055025326__p64330433145242">Specifies the project ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025326__row8558710145242"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.1.4.1.1 "><p id="en-dc_topic_0055025326__p54898609145242">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.1.4.1.2 "><p id="en-dc_topic_0055025326__p17602321145242">String</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.4.5.1.4.1.3 "><p id="en-dc_topic_0055025326__p61586011145242">Specifies the virtual gateway name.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025326__row45690210145242"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.1.4.1.1 "><p id="en-dc_topic_0055025326__p372676145242">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.1.4.1.2 "><p id="en-dc_topic_0055025326__p30186794145242">String</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.4.5.1.4.1.3 "><p id="en-dc_topic_0055025326__p17298602145242">Provides supplementary information about the virtual gateway.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025326__row27446311145242"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.1.4.1.1 "><p id="en-dc_topic_0055025326__p61323974145242">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.1.4.1.2 "><p id="en-dc_topic_0055025326__p1186027145242">String</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.4.5.1.4.1.3 "><p id="en-dc_topic_0055025326__p64008823145242">Specifies the ID of the VPC to be accessed.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025326__row40332292145242"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.1.4.1.1 "><p id="en-dc_topic_0055025326__p21771545145242">local_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.1.4.1.2 "><p id="en-dc_topic_0055025326__p18664711145242">String</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.4.5.1.4.1.3 "><p id="en-dc_topic_0055025326__p52604433145242">Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025326__row49220608145242"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.1.4.1.1 "><p id="en-dc_topic_0055025326__p29470565145242">device_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.1.4.1.2 "><p id="en-dc_topic_0055025326__p38305526145242">String</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.4.5.1.4.1.3 "><p id="en-dc_topic_0055025326__p66972050145242">Specifies the ID of the physical device used by the virtual gateway.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025326__row42751658145242"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.1.4.1.1 "><p id="en-dc_topic_0055025326__p34480858145242">redundant_device_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.1.4.1.2 "><p id="en-dc_topic_0055025326__p41486137145242">String</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.4.5.1.4.1.3 "><p id="en-dc_topic_0055025326__p64104220145242">Specifies the ID of the redundant physical device used by the virtual gateway.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025326__row59091091142819"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.1.4.1.1 "><p id="en-dc_topic_0055025326__p60721963142822">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.1.4.1.2 "><p id="en-dc_topic_0055025326__p19531943142822">String</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.4.5.1.4.1.3 "><p id="en-dc_topic_0055025326__p38261990142822">Specifies the virtual gateway type. The value can be <strong id="en-dc_topic_0055025326__b842352706232310">default</strong> or <strong id="en-dc_topic_0055025326__b842352706232316">double ipsec</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025326__row36208475104314"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.1.4.1.1 "><p id="en-dc_topic_0055025326__p53182731104317">ipsec_bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.1.4.1.2 "><p id="en-dc_topic_0055025326__p12833936104317">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.4.5.1.4.1.3 "><p id="en-dc_topic_0055025326__p48943060104317">Specifies the bandwidth provided for IPsec VPN in Mbit/s.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025326__row197045374404"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.1.4.1.1 "><p id="en-dc_topic_0055025326__p20892134016407">bgp_asn</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.1.4.1.2 "><p id="en-dc_topic_0055025326__p88921640114014">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.4.5.1.4.1.3 "><p id="en-dc_topic_0055025326__p118928402405">Specifies the BGP ASN of the virtual gateway.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025326__row34576346145242"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.1.4.1.1 "><p id="en-dc_topic_0055025326__p24207219145242">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.1.4.1.2 "><p id="en-dc_topic_0055025326__p14627737145242">String</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.4.5.1.4.1.3 "><p id="en-dc_topic_0055025326__p36429021144551">Specifies the virtual gateway status.</p>
<p id="en-dc_topic_0055025326__p6910742145242">The value can be <strong id="en-dc_topic_0055025326__b84235270617169">ACTIVE</strong>, <strong id="en-dc_topic_0055025326__b842352706171613">DOWN</strong>, <strong id="en-dc_topic_0055025326__b842352706171618">BUILD</strong>, <strong id="en-dc_topic_0055025326__b842352706171622">ERROR</strong>, <strong id="en-dc_topic_0055025326__b842352706171626">PENDING_CREATE</strong>, <strong id="en-dc_topic_0055025326__b842352706171630">PENDING_UPDATE</strong>, or <strong id="en-dc_topic_0055025326__b842352706171633">PENDING_DELETE</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025326__row26211437145242"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.1.4.1.1 "><p id="en-dc_topic_0055025326__p4766768145242">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.1.4.1.2 "><p id="en-dc_topic_0055025326__p50563943145242">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.4.5.1.4.1.3 "><p id="en-dc_topic_0055025326__p20943989144556">Specifies the administrative status of the virtual gateway.</p>
<p id="en-dc_topic_0055025326__p30920819145242">The value can be <strong id="en-dc_topic_0055025326__b842352706154840">true</strong> or <strong id="en-dc_topic_0055025326__b842352706154844">false</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025326__section5055526711495"><h4 class="sectiontitle">Examples</h4><ul id="en-dc_topic_0055025326__ul167491055192817"><li id="en-dc_topic_0055025326__li77491655122813">Example request<pre class="screen" id="en-dc_topic_0055025326__screen4017959713452">PUT /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
{
"virtual_gateway" : {
"name" : "virtual gateway1",
"description" : "New description"
}
}</pre>
</li></ul>
</div>
<ul id="en-dc_topic_0055025326__ul15710118172911"><li id="en-dc_topic_0055025326__li16710481294">Example response<pre class="screen" id="en-dc_topic_0055025326__screen1750762082916">{
"virtual_gateway" : {
"id" : "7ec892f3-ca64-46c7-863f-a2eb1b9e8389",
"tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
"name" : "virtual gateway1",
"description" : "New 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_0055025326__section1374333103913"><h4 class="sectiontitle">Returned Value</h4><p id="en-dc_topic_0055025326__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>