
# 查询VPN连接监控列表 - QueryVPNConnectionMonitors
#### 功能介绍
查询VPN连接监控列表。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-vpn/vpn_api_0008.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vpn/vpn_api_0044.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
| 授权项                         | 访问级别 | 资源类型（\*为必须）    | 条件键 | 别名 | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| vpn:connectionMonitors:list | list | vpnConnections | -   | -  | -      |
   
#### URI
GET /v5/{project_id}/connection-monitors
表1参数说明 
| 名称         | 类型     | 是否必选 | 说明                                                                                  |
|:---|:---|:---|:---|
| project_id | String | 是    | 项目ID，可以通过[获取项目ID](https://support.huaweicloud.com/api-vpn/vpn_api_0051.html)获取项目ID。 |
   
表2请求Query参数列表 
| 名称                    | 类型     | 是否必选 | 描述       |
|:---|:---|:---|:---|
| vpn_connection_id     | String | 否    | VPN连接ID。 |
| enterprise_project_id | Array  | 否    | 企业项目ID。  |
   
#### 请求消息
- 请求参数 无。
  
- 请求样例
  1. 查询所有VPN连接监控。
     ```
     GET https://{Endpoint}/v5/{project_id}/connection-monitors
     ```
     
  
  2. 根据vpn_connection_id查询VPN连接监控。
     ```
     GET https://{Endpoint}/v5/{project_id}/connection-monitors?vpn_connection_id={vpn_connection_id}
     ```
     
   
 
#### 响应消息
- 响应参数 返回状态码为 200: 查询成功。
  表3响应Body参数列表 
  | 名称                  | 类型                                                                                  | 描述                    |
  |:---|:---|:---|
  | connection_monitors | Array of [ConnectionMonitorInfo] objects | connection_monitor对象。 |
  | request_id          | String                                                                              | 请求ID。                 |
     
   表4ConnectionMonitorInfo 
  | 名称                | 类型     | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
  |:---|:---|:---|
  | id                | String | - 功能说明：VPN连接监控ID。  - 格式：36位UUID。                                                                                                                                                                                                                   |
  | status            | String | - 功能说明：VPN连接监控状态。  - 取值范围： ACTIVE：正常。 PENDING_CREATE：创建中。 PENDING_DELETE：删除中。    |
  | vpn_connection_id | String | - 功能说明：VPN连接监控对应的VPN连接ID。  - 格式：36位UUID。                                                                                                                                                                                                         |
  | type              | String | - 功能说明：监控类型。  - 取值范围： gateway：VPN网关。                                                                                                                                                   |
  | source_ip         | String | VPN连接监控的源地址。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  | destination_ip    | String | VPN连接监控的目的地址。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
  | proto_type        | String | - 功能说明：nqa使用的协议类型。  - 取值范围： icmp：ICMP协议。                                                                                                                                               |
     
  
- 响应样例
  1. 查询所有VPN连接监控的响应。
     ```
     {
         "connection_monitors":[
             {
                 "id":"76f64229-demo-a8df-va86-3907e2815b6d",
                 "status":"ACTIVE",
                 "vpn_connection_id":"2342adf2-demo-a8df-va86-12aq511s0917",
                 "type":"gateway",
                 "source_ip":"88.***.***.60",
                 "destination_ip":"88.***.***.32",
                 "proto_type":"icmp"
             },
             {
                 "id":"85t53318-demo-a8df-va86-zq9312525f6t",
                 "status":"ACTIVE",
                 "vpn_connection_id":"cae286f2-demo-a8df-va86-e22416ca1220",
                 "type":"gateway",
                 "source_ip":"89.***.***.21",
                 "destination_ip":"88.***.***.12",
                 "proto_type":"icmp"
             }
         ],
         "request_id": "531f8b2c-ec55-45d8-90a3-ede922f7d63c"
     }
     ```
     
  
  2. 根据vpn_connection_id查询VPN连接监控的响应。
     ```
     {
         "connection_monitors":[
             {
                 "id":"76f64229-demo-a8df-va86-3907e2815b6d",
                 "status":"ACTIVE",
                 "vpn_connection_id":"2342adf2-demo-a8df-va86-12aq511s0917",
                 "type":"gateway",
                 "source_ip":"88.***.***.60",
                 "destination_ip":"88.***.***.32",
                 "proto_type":"icmp"
             }
         ],
         "request_id": "05ab9b58-9b4c-4cee-8113-4b0f325f1dfc"
     }
     ```
     
   
 
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-vpn/vpn_api_0052.html)。
