forked from docs/doc-exports
Hongwei, King Wang
32c06a10a2
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>
192 lines
20 KiB
HTML
192 lines
20 KiB
HTML
<a name="EN-US_TOPIC_0000001807530304"></a><a name="EN-US_TOPIC_0000001807530304"></a>
|
|
|
|
<h1 class="topictitle1">Creating a VPN Connection Monitor</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_section20114008"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p85401835121019">This API is used to create a VPN connection monitor to perform health check between gateways. After a VPN connection monitor is created, the VPN gateway sends probe packets to the customer gateway to collect statistics about the round-trip delay and packet loss rate, thereby monitoring quality of VPN connections between the gateways.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_section18104173342818"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p148251658163211">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_0000001807530304__en-us_topic_0000001543513464_section46808346"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p5626424195519">POST /v5/{project_id}/connection-monitors</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_table3672032" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row10026740"><th align="left" class="cellrowborder" valign="top" width="20.61793820617938%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p6859639">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.02809719028097%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p179611479215">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.798820117988202%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p18759866">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.555144485551445%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p43154149">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row5825185"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p2077973">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.02809719028097%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p177965479212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.798820117988202%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p34098154">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.555144485551445%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_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>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_section18621933"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_ul5992193374713"><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li59922337473">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_table72094" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row1018201645"><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_0000001807530304__en-us_topic_0000001543513464_p20181701747">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_0000001807530304__en-us_topic_0000001543513464_p5191903415">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_0000001807530304__en-us_topic_0000001543513464_p141918015410">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_0000001807530304__en-us_topic_0000001543513464_p11190014415">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row1618000413"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p519180545">connection_monitor</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_0000001807530304__en-us_topic_0000001543513464_p17191102414"><a href="#EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_table72095">CreateConnectionMonitorRequestBodyContent</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_0000001807530304__en-us_topic_0000001543513464_p1119804417">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_0000001807530304__en-us_topic_0000001543513464_p319190345">Specifies the connection_monitor object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_table72095"></a><a name="en-us_topic_0000001543513464_table72095"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_table72095" frame="border" border="1" rules="all"><caption><b>Table 3 </b>CreateConnectionMonitorRequestBodyContent</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row3200015413"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p52090844">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p1020909415">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_0000001807530304__en-us_topic_0000001543513464_p11201801342">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_0000001807530304__en-us_topic_0000001543513464_p1320301742">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row4201501743"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p10548435111013">vpn_connection_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p421190643">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_0000001807530304__en-us_topic_0000001543513464_p202170449">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p1621601244">Specifies the ID of the VPN connection to be monitored.</p>
|
|
<p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p023264525810">You can obtain VPN connection IDs by <a href="vpn_api_0029.html#EN-US_TOPIC_0000001807530300">querying the VPN connection list</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li1228904881815">Example request<pre class="screen" id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_screen1778465375316">POST https://{Endpoint}/v5/{project_id}/connection-monitors
|
|
|
|
{
|
|
"connection_monitor": {
|
|
"vpn_connection_id": "cae286f2-demo-a8df-va86-e22416ca1220"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_section33379675"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_ul2144514204819"><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li61441714114816">Response parameters<p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p3232011411"><a name="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li61441714114816"></a><a name="en-us_topic_0000001543513464_li61441714114816"></a>Returned status code 201: successful operation</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_table72096" 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_0000001807530304__en-us_topic_0000001543513464_row17235017411"><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_0000001807530304__en-us_topic_0000001543513464_p13241901447">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_0000001807530304__en-us_topic_0000001543513464_p6241002418">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_0000001807530304__en-us_topic_0000001543513464_p2241001448">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row3231008412"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p17241801412">connection_monitor</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_0000001807530304__en-us_topic_0000001543513464_p8241201348"><a href="#EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_table72097">ConnectionMonitorInfo</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_0000001807530304__en-us_topic_0000001543513464_p324801149">Specifies the connection_monitor object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row5397103519142"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p19807143518129">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_0000001807530304__en-us_topic_0000001543513464_p3807153571217">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_0000001807530304__en-us_topic_0000001543513464_p2807535171212">Specifies a request ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_table72097"></a><a name="en-us_topic_0000001543513464_table72097"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_table72097" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ConnectionMonitorInfo</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row17251602414"><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_0000001807530304__en-us_topic_0000001543513464_p11553163541018">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_0000001807530304__en-us_topic_0000001543513464_p1755319357103">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_0000001807530304__en-us_topic_0000001543513464_p0553435111018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row112512018420"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p1055393519108">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_0000001807530304__en-us_topic_0000001543513464_p2055423551016">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_0000001807530304__en-us_topic_0000001543513464_ul1064673414438"><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li4646123404312">Specifies the ID of a VPN connection monitor.</li><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li2044713122414">The value is a UUID containing 36 characters.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row12102153345519"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p57922040185518">vpn_connection_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_0000001807530304__en-us_topic_0000001543513464_p679254017559">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_0000001807530304__en-us_topic_0000001543513464_ul879374020551"><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li15793114045512">Specifies the ID of the VPN connection to be monitored.</li><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li1479354015550">The value is a UUID containing 36 characters.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row358536155518"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p12793194013554">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_0000001807530304__en-us_topic_0000001543513464_p1679314408558">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_0000001807530304__en-us_topic_0000001543513464_ul1779344045519"><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li27934401558">Specifies the type of objects to be monitored.</li><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li1679314015515">The value can only be <strong id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_b8891143182219">gateway</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row20831181216819"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p139822044124213">source_ip</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_0000001807530304__en-us_topic_0000001543513464_p1698213447424">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_0000001807530304__en-us_topic_0000001543513464_p298294415424">Specifies the source address to be monitored.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row162132171083"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p11982194416426">destination_ip</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_0000001807530304__en-us_topic_0000001543513464_p20982744154212">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_0000001807530304__en-us_topic_0000001543513464_p10983544104213">Specifies the destination address to be monitored.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row225130444"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p189831544174212">proto_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_0000001807530304__en-us_topic_0000001543513464_p0983184417427">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_0000001807530304__en-us_topic_0000001543513464_ul1178312588143"><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li1176782131516">Specifies the protocol used by NQA.</li><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li156188711153">The value can only be <strong id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_b105071354162215">icmp</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li75881259181813">Example response<pre class="screen" id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_screen678017232489">{
|
|
"connection_monitor":{
|
|
"id":"76f64229-demo-a8df-va86-3907e2815b6d",
|
|
"vpn_connection_id":"cae286f2-demo-a8df-va86-e22416ca1220",
|
|
"type":"gateway",
|
|
"source_ip":"88.***.***.60",
|
|
"destination_ip":"88.***.***.32",
|
|
"proto_type":"icmp"
|
|
},
|
|
"request_id": "bd37d16d-387c-41ab-a180-01b649f73590"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_section31981619"><h4 class="sectiontitle">Status Codes</h4><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_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_0032.html">VPN Connection Monitoring</a></div>
|
|
</div>
|
|
</div>
|
|
|