
# 查询P2C VPN网关 - QueryP2CVPNGateway
#### 功能介绍
根据P2C VPN网关ID，查询指定的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:p2cVpnGateway:get | read | p2cVpnGateway | - [g:ResourceTag/\<tag-key\>](https://support.huaweicloud.com/usermanual-iam5/iam_01_0934.html#section2)   | -  | -      |
   
#### URI
GET /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}
表1参数说明 
| 名称         | 类型     | 是否必选 | 描述                                                                                  |
|:---|:---|:---|:---|
| project_id | String | 是    | 项目ID，可以通过[获取项目ID](https://support.huaweicloud.com/api-vpn/vpn_api_0051.html)获取项目ID。 |
| p2c_vgw_id | String | 是    | P2C VPN网关实例ID。                                                                      |
   
#### 请求消息
- 请求参数 无。
  
- 请求样例
  ```
  GET https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}
  ```
  
 
#### 响应消息
- 响应参数 返回状态码为 200: 查询成功。
  表2响应Body参数列表 
  | 名称              | 类型                                                                                                                        | 描述             |
  |:---|:---|:---|
  | p2c_vpn_gateway | [p2c_vpn_gateway] object | vpn_gateway对象。 |
  | request_id      | String                                                                                                                    | 请求ID。          |
     
   表3p2c_vpn_gateway 
  | 名称                        | 类型                                                                                                                                 | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
  |:---|:---|:---|
  | id                        | String                                                                                                                             | - 功能说明：P2C VPN网关ID。  - 格式：36位UUID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
  | name                      | String                                                                                                                             | - 功能说明：P2C VPN网关名称。  - 取值范围：1-64个字符，支持数字、英文字母、中文（\\u4e00 - \\u9fa5）、_（下划线）、-（中划线）。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  | status                    | String                                                                                                                             | - 功能说明：P2C VPN网关状态。  - 取值范围： PENDING_CREATE：创建中。 PENDING_UPDATE：更新中。 PENDING_DELETE：删除中。 UPGRADING：升级中。 ROLLING_BACK：回退中。 PENDING_UPGRADE_CONFIRM：确认升级。 ACTIVE：正常。 FAULT：异常。 FROZEN：冻结。    |
  | vpc_id                    | String                                                                                                                             | P2C VPN网关所连接的VPC的ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  | connect_subnet            | String                                                                                                                             | P2C VPN网关所使用的VPC子网ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  | flavor                    | String                                                                                                                             | - 功能说明：P2C VPN网关的规格类型。  - 取值范围: Professional1：专业型1。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
  | availability_zone_ids     | Array of strings                                                                                                                   | 可用区列表。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
  | eip                       | [ResponseEipInfo] object           | 网关绑定的EIP信息。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
  | max_connection_number     | Integer                                                                                                                            | - 功能说明：最多支持同时在线的客户端连接数。  - 取值范围：1\~500。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  | current_connection_number | Integer                                                                                                                            | 当前建连的客户端连接数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
  | enterprise_project_id     | string                                                                                                                             | 企业项目ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
  | tags                      | Array of [VpnResourceTag] objects | 标签列表。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  | order_id                  | String                                                                                                                             | 订单ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  | admin_state_up            | Boolean                                                                                                                            | - 功能说明：冻结状态。  - 取值范围： true：未冻结。 false：冻结。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
  | frozen_effect             | Integer                                                                                                                            | - 功能说明：冻结影响，标识该资源冻结后是否可以删除。  - 取值范围： 0：未冻结。 1：冻结可删除。 2：冻结不可删除。                                                                                                                                                                                                                                                                                                                                                                                                                  |
  | version                   | string                                                                                                                             | - 功能说明：网关版本。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
  | upgrade_info              | string                                                                                                                             | - 功能说明：升级信息。  - 取值范围： - ready：可以升级。  - expiring soon：即将过期。  - unready：无法升级。                                                                                                                                                                                                               |
  | created_at                | String                                                                                                                             | - 功能说明：创建时间。  - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ*。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
  | applied_at                | String                                                                                                                             | - 功能说明：生效时间。  - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ*。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
  | updated_at                | String                                                                                                                             | - 功能说明：最后一次更新时间。  - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ*。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
     
   表4ResponseEipInfo 
  | 名称                     | 类型      | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
  |:---|:---|:---|
  | id                     | String  | - 功能说明：EIP的ID。  - 格式：36位UUID。                                                                                                                                                                                                                                                                                                               |
  | ip_version             | Integer | - 功能说明：EIP版本。  - 取值范围：4。                                                                                                                                                                                                                                                                                                                |
  | ip_billing_info        | String  | - 功能说明：EIP的订单信息。包年/包月EIP才会返回订单信息，按需计费的EIP不返回。  - 格式：order_id:product_id:region_id:project_id，如： CS22\*\*\*\*\*\*\*\*LIBIV:00301-\*\*\*\*\*\*-0--0:br-iaas-odin1:0605768a\*\*\*\*\*\*\*\*\*\*\*\*c006c7e484aa。                                                      |
  | type                   | String  | - 功能说明：EIP的类型。  - 取值范围：5_bgp（全动态BGP），5_sbgp（静态BGP），5_youxuanbgp（优选BGP） 可查看[申请EIP](https://support.huaweicloud.com/api-eip/eip_api_0001.html)[表6](https://support.huaweicloud.com/api-vpn/vpn_api_0014.html#ZH-CN_TOPIC_0000001594352981__table65353)中type字段的取值范围。    |
  | ip_address             | String  | - 功能说明：EIP的公网IPv4地址。  - 格式：ipv4类型地址。例如：88.\*\*\*.\*\*\*.11。                                                                                                                                                                                                                                                                          |
  | charge_mode            | String  | - 功能说明：EIP的带宽计费模式。                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | bandwidth_id           | String  | - 功能说明：EIP的带宽ID。  - 格式：36位UUID。                                                                                                                                                                                                                                                                                                       |
  | bandwidth_size         | Integer | - 功能说明：EIP的带宽大小，单位：Mbit/s。每个region能够提供的EIP最大带宽不同，EIP的最大带宽受限于EIP服务，可以使用工单来提高账户下的EIP的最大带宽。  - 取值范围：1-1000，具体取值请参考弹性公网服务创建EIP资料。                                                                                                                                                                                                         |
  | bandwidth_name         | String  | - 功能说明：EIP的带宽名称。  - 取值范围：1-64个字符，支持数字、英文字母、中文(\\u4e00 - \\u9fa5)、_(下划线)、-(中划线)、.(点)。                                                                                                                                                                                                                                                |
  | bandwidth_billing_info | String  | - 功能说明：EIP的带宽订单信息。包年/包月EIP带宽才会返回带宽订单信息，按需计费的EIP带宽不返回。  - 格式：order_id:product_id:region_id:project_id，如： CS22\*\*\*\*\*\*\*\*LIBIV:00301-\*\*\*\*\*\*-0--0:br-iaas-odin1:0605768a\*\*\*\*\*\*\*\*\*\*\*\*c006c7e484aa。                                              |
  | share_type             | String  | - 功能说明: 带宽共享类型。  - 取值范围： PER：独享带宽。                                                                                                                                                                                                                                 |
     
   表5VpnResourceTag 
  | 名称    | 类型     | 描述                                                                                                                                                                                                                                                                                                                          |
  |:---|:---|:---|
  | key   | String | - 功能说明：标签的键。  - 取值范围：1-128个字符，支持任意语种字母、数字、空格和_.:=+-@，但首尾不能含有空格，不能以_sys_开头。   |
  | value | String | - 功能说明：标签的值。  - 取值范围：0-255个字符，支持任意语种字母、数字、空格和_.:/=+-@。                         |
     
  
- 响应样例
  ```
  {
      "p2c_vpn_gateway": {
          "id": "6d526e5f-a0c6-44b6-a785-000000000000",
          "name": "p2c-vpngw-0000",
          "status": "ACTIVE",
          "vpc_id": "05b9d7de-9acd-4a05-b497-1a3c75afaa0a",
          "connect_subnet": "1948ce22-ddc5-4fb6-87b8-dfcc9b176b51",
          "flavor": "Professional1",
          "availability_zone_ids": [
              "cn-south-1f",
              "cn-south-1e"
          ],
          "eip": {
              "id": "f0bac06a-88a7-4d37-8e2e-c37691ee4ba2",
              "ip_version": 4,
              "ip_billing_info": "CS*********JWT1O:OFFI*************5078:cn-south-1:47190474************98781092d16c",
              "type": "5_youxuanbgp",
              "ip_address": "215.***.***.120",
              "charge_mode": "bandwidth",
              "bandwidth_id": "3456471c-9dac-40f6-8344-daca14fbd81e",
              "bandwidth_size": 20,
              "bandwidth_name": "p2c-vpngw-bandwidth-bd61",
              "bandwidth_billing_info": "CS*********JWT1O:OFFI*************5078:cn-south-1:47190474************98781092d16c",
              "share_type": "PER"
          },
          "max_connection_number": 10,
          "current_connection_number": 0,
          "tags": [],
          "order_id": "CS**********JWT1O",
          "admin_state_up": true,
          "frozen_effect": 0,
          "created_at": "2024-06-14T10:24:12.147Z",
          "updated_at": "2024-06-14T10:24:12.147Z"
      },
      "request_id": "2ddd2f6107a8164ce6f6268bd991e57c"
  }
  ```
  
 
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-vpn/vpn_api_0052.html)。
