计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

查询VPN网关

功能介绍

根据VPN网关ID,查询指定的VPN网关。

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/vpn-gateways/{vgw_id}

表1 参数说明

名称

类型

是否必选

说明

project_id

String

项目ID,可以通过获取项目ID获取项目ID。

vgw_id

String

VPN网关ID。

请求消息

  • 请求参数

    无。

  • 请求样例
    GET https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id}

响应消息

  • 响应参数

    返回状态码为 200: 查询成功。

    表2 响应Body参数列表

    名称

    类型

    描述

    vpn_gateway

    ResponseVpnGateway object

    vpn_gateway对象。

    request_id

    String

    请求ID。

    表3 ResponseVpnGateway

    名称

    类型

    描述

    id

    String

    • 功能说明:VPN网关ID。
    • 格式:36位UUID。

    name

    String

    • 功能说明:VPN网关名称。
    • 取值范围:1-64个字符,支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(点)。

    network_type

    String

    • 功能说明:VPN网关网络类型。
    • 取值范围:public,private。
    • 默认值:public。

    status

    String

    • 功能说明:VPN网关状态。
    • 取值范围:

      PENDING_CREATE:创建中。

      PENDING_UPDATE:更新中。

      PENDING_DELETE:删除中。

      ACTIVE:正常。

      FAULT:异常。

      FREEZED:冻结。

    attachment_type

    String

    • 功能说明:关联模式。
    • 取值范围:vpc,er。

    ip_version

    String

    • 功能说明:VPN网关的IP协议版本。
    • 取值范围:ipv4、ipv6。

    certificate_id

    String

    • 功能说明:证书ID。
    • 格式:36位UUID。

    er_id

    String

    VPN网关所连接的ER实例的ID。仅当attachment_type为er时返回。

    vpc_id

    String

    VPN网关关联的业务VPC的ID。仅当attachment_type为vpc时返回。

    local_subnets

    Array of String

    IPv4本端子网。本端子网是云上子网,该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例:192.168.52.0/24。仅当attachment_type为vpc且ip_version为ipv4时返回。

    local_subnets_v6

    Array of String

    IPv6本端子网。本端子网是云上子网,该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例:16af:cacc:1097::/48。仅当attachment_type为vpc且ip_version为ipv6时返回。

    connect_subnet

    String

    VPN网关所使用的VPC中的一个子网ID。

    bgp_asn

    Long

    VPN网关的BGP自治域编号。

    flavor

    String

    • 功能说明:VPN网关的规格类型。
    • 取值范围:

      Basic:最大转发带宽100Mbps。

      Professional1:最大转发带宽300Mbps。

      Professional1-NonFixedIP:最大转发带宽300Mbps。

      Professional2:最大转发带宽1Gbps。

      Professional2-NonFixedIP:最大转发带宽1Gbps。

      GM:最大转发带宽500Mbps。

    availability_zone_ids

    Array of String

    部署VPN网关的可用区。当指定了可用区时则返回;当未指定可用区时,在VPN网关的状态为ACTIVE时返回。

    public_border_group

    String

    公共边界组

    connection_number

    Integer

    VPN网关下的最大VPN连接数。

    used_connection_number

    Integer

    VPN网关下当前已经使用的VPN连接数。

    used_connection_group

    Integer

    VPN网关下当前已经使用的VPN连接组个数。同一用户网关入云的两条连接组成一个连接组。VPN网关默认支持10个免费的VPN连接组。

    enterprise_project_id

    String

    • 功能说明:企业项目ID。
    • 格式:36位UUID。创建时不传则返回"0",表示资源属于default企业项目。

      注:"0"并不是真实存在的企业项目ID。

    eip1

    ResponseEip object

    双活VPN网关表示使用的第一个EIP,主备模式VPN网关表示主EIP。在VPN网关的状态为ACTIVE时返回。

    eip2

    ResponseEip object

    双活VPN网关表示使用的第二个EIP,主备模式VPN网关表示备EIP。在VPN网关的状态为ACTIVE时返回。

    created_at

    String

    • 创建时间。在VPN网关的状态为ACTIVE时返回。
    • UTC时间格式:yyyy-MM-ddTHH:mm:ssZ。

    updated_at

    String

    • 最后一次更新时间。在VPN网关的状态为ACTIVE时返回。
    • UTC时间格式:yyyy-MM-ddTHH:mm:ssZ。

    access_vpc_id

    String

    • 功能说明:VPN网关使用的接入VPC ID。
    • 格式:36位UUID。

    access_subnet_id

    String

    • 功能说明:VPN网关使用的接入VPC中的子网ID。
    • 格式:36位UUID。

    access_private_ip_1

    String

    私网类型VPN网关的接入私网IP,VPN网关使用该私网IP与对端网关建连。双活网关表示使用的第一个私网地址,主备表示主私网地址。

    示例:192.168.52.9。仅当network_type为private时返回。

    access_private_ip_2

    String

    私网类型VPN网关的接入私网IP,VPN网关使用该私网IP与对端网关建连。双活网关表示使用的第二个私网地址,主备表示备私网地址。

    示例:192.168.52.9。仅当network_type为private时返回。

    certificate_id

    String

    • 功能说明:VPN网关使用的VPN网关证书ID,仅在flavor为GM时返回。
    • 格式:36位UUID

    ha_mode

    String

    • 功能说明:网关的HA模式,"active-active"表示双活,"active-standby"表示主备。
    • 取值范围:active-active,active-standby。
    • 默认值:active-active。

    policy_template

    PolicyTemplate object

    非固定IP接入VPN网关网关的策略模板配置,只有在规格为非固定IP接入VPN网关时返回。

    supported_flavors

    Array of String

    网关可升配到的目标规格。

    tags

    Array of VpnResourceTag objects

    标签列表。

    表4 ResponseEip

    名称

    类型

    描述

    id

    String

    • 功能说明:EIP的ID。
    • 格式:36位UUID。当使用默认企业项目时返回"0"。

    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的类型。
    • 取值范围:可查看申请EIP表6中type字段的取值范围。

    ip_address

    String

    • 功能说明:EIP的公网IPv4地址。
    • 格式:ipv4类型地址。例如:88.***.***.11。

    charge_mode

    String

    • 功能说明:EIP的带宽计费模式。按流量计费或按带宽计费。
    • 取值范围:

      bandwidth:按带宽计费。

      traffic:按流量计费。

    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:独享带宽

      WHOLE:共享带宽

    表5 PolicyTemplate

    名称

    类型

    描述

    ike_policy

    IkePolicy object

    ike 策略对象。

    ipsec_policy

    IpsecPolicy object

    ipsec 策略对象。

    表6 IkePolicy

    名称

    类型

    描述

    encryption_algorithm

    String

    • 功能说明:加密算法。
    • 取值范围:aes-256-gcm-16,aes-128-gcm-16,aes-256,aes-192,aes-128。

    dh_group

    String

    • 功能说明:第一阶段密钥交换使用的DH组。
    • 取值范围:group14,group15,group16,group19,group20,group21,disable。

    authentication_algorithm

    String

    • 功能说明:认证算法。
    • 取值范围:sha2-512,sha2-384,sha2-256。

    lifetime_seconds

    Integer

    • 功能说明:表示SA的生存周期,当该生存周期超时后IKE SA将自动更新。
    • 取值范围:60-604800,单位:秒。
    表7 IpsecPolicy

    名称

    类型

    描述

    authentication_algorithm

    String

    • 功能说明:认证算法。
    • 取值范围:sha2-512,sha2-384,sha2-256。

    encryption_algorithm

    String

    • 功能说明:加密算法。
    • 取值范围:aes-256-gcm-16,aes-128-gcm-16,aes-256,aes-192,aes-128。

    pfs

    String

    • 功能说明:PFS使用的DH密钥组。
    • 取值范围:group14,group15,group16,group19,group20,group21,disable。

    lifetime_seconds

    Integer

    • 功能说明:表示配置IPSec连接建立的隧道以时间为基准的生存周期。
    • 取值范围:30-604800,单位:秒。
    表8 VpnResourceTag

    名称

    类型

    描述

    key

    String

    • 功能说明:标签的键。
    • 取值范围:1-128个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。

    value

    String

    • 功能说明:标签的值。
    • 取值范围:0-255个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。
  • 响应样例
    1. 查询公网类型关联ER的VPN网关。
      {
          "vpn_gateway": {
              "id": "66ddeacb-demo-a8df-va86-9a414b5bd7d5",
              "name": "vpngw-5bd6",
              "network_type": "public",
              "status": "ACTIVE",
              "attachment_type": "er",
              "ip_version": "ipv4",
              "er_id": "c62fad0d-demo-a8df-va86-e06c4c351b9f",
              "bgp_asn": 64512,
              "flavor": "Professional1",
              "availability_zone_ids": ["cn-south-1f", "cn-south-1e"],
              "connection_number": 200,
              "used_connection_number": 0,
              "used_connection_group": 0,
              "enterprise_project_id": "0",
              "eip1": {
                  "id": "0f6d1415-demo-a8df-va86-edb2ee97c9cc",
                  "ip_version": 4,
                  "type": "5_bgp",
                  "ip_address": "88.***.***.251",
                  "charge_mode": "bandwidth",
                  "bandwidth_id": "e93767cc-demo-a8df-va86-bac2987f90a4",
                  "bandwidth_size": 300,
                  "bandwidth_name": "vpngw-bandwidth-10c3"
              },
              "eip2": {
                  "id": "7b46b62f-demo-a8df-va86-6b8e44312416",
                  "ip_version": 4,
                  "type": "5_bgp",
                  "ip_address": "88.***.***.102",
                  "charge_mode": "bandwidth",
                  "bandwidth_id": "bde3557e-demo-a8df-va86-629a3754ae07",
                  "bandwidth_size": 300,
                  "bandwidth_name": "vpngw-bandwidth-18bd"
              },
              "created_at": "2022-11-28T02:22:27.24Z",
              "updated_at": "2022-11-28T02:22:27.24Z",
              "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa",
              "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114",
              "ha_mode": "active-active"
          },
          "request_id": "28b795f8-d431-4f1e-93ab-1c401a82b799"
      }
    2. 查询私网类型关联VPC的VPN网关。
      {
          "vpn_gateway": {
              "id": "66ddeacb-demo-a8df-va86-9a414b5bd7d5",
              "name": "vpngw-5bd6",
              "network_type": "private",
              "status": "ACTIVE",
              "attachment_type": "vpc",
              "ip_version": "ipv4",
              "vpc_id": "91a74241-demo-a8df-va86-9b5f98c66c8c",
              "local_subnets": ["192.168.0.0/24"],
              "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114",
              "bgp_asn": 64512,
              "flavor": "Professional1",
              "availability_zone_ids": ["cn-south-1f", "cn-south-1e"],
              "connection_number": 200,
              "used_connection_number": 0,
              "used_connection_group": 0,
              "enterprise_project_id": "0",
              "created_at": "2022-11-28T02:22:27.24Z",
              "updated_at": "2022-11-28T02:22:27.24Z",
              "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa",
              "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114",
              "access_private_ip_1": "192.168.146.45",
              "access_private_ip_2":  "192.168.146.77",
              "ha_mode": "active-active"
          },
          "request_id": "28b795f8-d431-4f1e-93ab-1c401a82b799"
      }
    3. 查询公网类型关联VPC的非固定IP接入VPN网关。
      {
          "vpn_gateway":{
              "id":"66ddeacb-demo-a8df-va86-9a414b5bd7d5",
              "name":"vpngw-5bd6",
              "network_type":"public",
              "status":"ACTIVE",
              "attachment_type":"vpc",
              "ip_version": "ipv4",
              "vpc_id":"c62fad0d-demo-a8df-va86-e06c4c351b9f",
              "local_subnets":[
                  "192.168.0.0/24"
              ],
              "connect_subnet":"fd75bf7b-demo-a8df-va86-db13f03e299a",
              "bgp_asn":64512,
              "flavor":"Professional1-NonFixedIP",
              "availability_zone_ids":[
                  "cn-north-7c"
              ],
              "connection_number":200,
              "used_connection_number":0,
              "used_connection_group":0,
              "enterprise_project_id":"0",
              "ha_mode":"active-standby",
              "eip1":{
                  "id":"0f6d1415-demo-a8df-va86-edb2ee97c9cc",
                  "ip_version":4,
                  "type":"5_bgp",
                  "ip_address":"88.***.***.251",
                  "charge_mode":"bandwidth",
                  "bandwidth_id":"e93767cc-demo-a8df-va86-bac2987f90a4",
                  "bandwidth_size":300,
                  "bandwidth_name":"vpngw-bandwidth-10c3"
              },
              "eip2":{
                  "id":"7b46b62f-demo-a8df-va86-6b8e44312416",
                  "ip_version":4,
                  "type":"5_bgp",
                  "ip_address":"88.***.***.102",
                  "charge_mode":"bandwidth",
                  "bandwidth_id":"bde3557e-demo-a8df-va86-629a3754ae07",
                  "bandwidth_size":300,
                  "bandwidth_name":"vpngw-bandwidth-18bd"
              },
              "policy_template":{
                  "ike_policy":{
                      "encryption_algorithm":"aes-128",
                      "dh_group":"group20",
                      "authentication_algorithm":"sha2-256",
                      "lifetime_seconds":86400
                  },
                  "ipsec_policy":{
                      "authentication_algorithm":"sha2-256",
                      "encryption_algorithm":"aes-128",
                      "pfs":"group20",
                      "lifetime_seconds":3600
                  }
              },
              "created_at":"2022-11-28T02:22:27.24Z",
              "updated_at":"2022-11-28T02:22:27.24Z",
              "access_vpc_id":"4d03fe2d--demo-a8df-va86-6def96440f2b",
              "access_subnet_id":"fd75bf7b--demo-a8df-va86-e-db13f03e299a"
          },
          "request_id":"28b795f8-d431-4f1e-93ab-1c401a82b799"
      }

状态码

请参见状态码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容