vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpn/api-ref/vpn_api_0024.html
Hongwei, King Wang 32c06a10a2 vpn_api 
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
Co-committed-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
2024-08-15 14:18:28 +00:00

242 lines
26 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001854089193"></a><a name="EN-US_TOPIC_0000001854089193"></a>
<h1 class="topictitle1">Updating a Customer Gateway</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_section20114008"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p08081523415">This API is used to update a customer gateway with a specified gateway ID. Only the gateway name and certificate can be updated. To modify other parameters, you need to create another customer gateway.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_section18104173342818"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p9631339123219">For details, see <a href="vpn_api_0008.html#EN-US_TOPIC_0000001807530276">Calling APIs</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_section46808346"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p10231331145016">PUT /v5/{project_id}/customer-gateways/{customer_gateway_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_table92225" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row12962925142817"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p14962112592812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p10962102592810">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p19962142515281">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p1296310259282">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row17962625132817"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p18963142592816">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p096314254287">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p696362532810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p199639252285">Specifies a project ID. You can obtain the project ID by referring to <a href="vpn_api_0051.html#EN-US_TOPIC_0000001807530332">Obtaining the Project ID</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row696215259282"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p1796302518287">customer_gateway_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p496312516283">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p9963152511285">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p15964825102814">Specifies a customer gateway ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_section18621933"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul5992193374713"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li59922337473">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_table65456" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row88149238116"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p5814142314116">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p18143231114">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p1981518231511">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p1081572314111">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row14814152313119"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p16815123115">customer_gateway</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p1781512232110"><a href="#EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_table65457">UpdateCgwRequestBodyContent</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p4815423511">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p881511231214">Specifies the customer gateway object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_table65457"></a><a name="en-us_topic_0000001543513476_table65457"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_table65457" frame="border" border="1" rules="all"><caption><b>Table 3 </b>UpdateCgwRequestBodyContent</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row158151923514"><th align="left" class="cellrowborder" valign="top" width="19.19607843137255%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p081662311111">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.019607843137255%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p16816152317119">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p681612231616">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p1581632312117">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row481542319114"><td class="cellrowborder" valign="top" width="19.19607843137255%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p681612310110">name</p>
</td>
<td class="cellrowborder" valign="top" width="20.019607843137255%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p1816623111">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p181712231813">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul65231833153920"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li152316335391">Specifies a gateway name.</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li155230331394">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), hyphens (-), and periods (.).</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li5128234115719">Example request<pre class="screen" id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_screen1778465375316">PUT https://{Endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id}
{
"customer_gateway": {
"name": "cgw-f846",
}
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_section33379675"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul2144514204819"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li61441714114816">Response parameters<p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p2819323716"><a name="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li61441714114816"></a><a name="en-us_topic_0000001543513476_li61441714114816"></a>Returned status code 200: successful update</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_table65458" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameters in the response body</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row681972311111"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p1881918236119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p18199239119">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p5820423715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row181932313112"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p15820132319117">customer_gateway</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p2716866203"><a href="#EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_table92231">ResponseCustomerGateway</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p5820112315112">Specifies the customer gateway object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row1081916239115"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p11820823211">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p168208231114">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p15821152318118">Specifies a request ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_table92231"></a><a name="en-us_topic_0000001543513476_table92231"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_table92231" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ResponseCustomerGateway</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row99751325102811"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p149752258284">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p797618253286">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p11976192512814">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row8975102562820"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p3919102572812">id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p591910250283">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul4510103818305"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li156736439303">Specifies a customer gateway ID.</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li1525265511233">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row197513253287"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p1391952512818">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p391922552810">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul4955105118115"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li7955551161115">Specifies a customer gateway name. If no customer gateway name is specified, the system automatically generates one.</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li1987916110130">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), and hyphens (-).</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row2088992035714"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p18721658125115">id_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p2072358145113">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul192612345211"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li2266317525">Specifies the identifier type of a customer gateway.</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li122673135214">Value range:<ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul5641183054411"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li2604152816439">ip</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li59351785513">fqdn (currently not supported)</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row8541161914572"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p207245895119">id_value</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p1672358125117">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p1685712819529">Specifies the identifier of a customer gateway.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row2097515257283"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p129991311174411">bgp_asn</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p169990110444">Long</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p179561588484">Specifies the BGP AS number of the customer gateway. This parameter is available only when <strong id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_b15272848141210">id_type</strong> is set to <strong id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_b1272184841215">ip</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row169752252281"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p992272572816">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p149220255281">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul19731344142314"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li14524204712316">Specifies the time when the customer gateway is created.</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li1273144412235">The UTC time format is <em id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_i97633018933929">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row1797516256280"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p3923122511285">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p8923202562810">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul6106151392213"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li18524164752316">Specifies the last update time.</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li1277785732017">The UTC time format is <em id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_i58220855933929">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row487175594011"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p14785225145413">tags</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p147855259548">Array of <a href="#EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_table4138248135518">VpnResourceTag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p1280042717591">Specifies a tag list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_table4138248135518"></a><a name="en-us_topic_0000001543513476_table4138248135518"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_table4138248135518" frame="border" border="1" rules="all"><caption><b>Table 6 </b>VpnResourceTag</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row313874885517"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.4.2.4.1.1"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p1613864810559">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.009999999999998%" id="mcps1.3.5.2.1.4.2.4.1.2"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p11138114805517">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.769999999999996%" id="mcps1.3.5.2.1.4.2.4.1.3"><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p913874812558">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row5138148125515"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p121761293375">key</p>
</td>
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p41771729153718">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul4177729133712"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li1217762923713">Specifies a tag key.</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li41771629103713">The value is a string of 1 to 128 characters that can contain digits, letters, Spanish characters, Portuguese characters, spaces, and special characters (_ . : = + - @).</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row16139174885513"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p171774293371">value</p>
</td>
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p1617782919374">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul10177112943717"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li1917702915375">Specifies a tag value.</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li11177152993718">The value is a string of 0 to 255 characters that can contain digits, letters, Spanish characters, Portuguese characters, spaces, and special characters (_ . : = + - @).</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li161655475720">Example response<pre class="screen" id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_screen678017232489">{
"customer_gateway": {
"id": "03c0aa3d-demo-a8df-va86-9d82473765d4",
"name": "cgw-f846",
"id_type": "ip",
"id_value": "10.***.***.21",
"bgp_asn": 65533,
"created_at": "2021-12-21T16:49:28.108Z",
"updated_at": "2021-12-21T16:49:28.108Z"
},
"request_id": "96718f4a-f57a-4e1f-8d05-7d5e903c8d90"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_section31981619"><h4 class="sectiontitle">Status Codes</h4><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p18112112662914">For details, see <a href="vpn_api_0052.html#EN-US_TOPIC_0000001807370508">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0020.html">Customer Gateway</a></div>
</div>
</div>
View Git Blame Copy Permalink