计算
弹性云服务器 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连接

功能介绍

根据连接ID,查询指定的VPN连接的参数。

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/vpn-connection/{vpn_connection_id}

表1 参数说明

名称

类型

是否必选

说明

project_id

String

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

vpn_connection_id

String

VPN连接ID。

请求消息

  • 请求参数

    无。

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

响应消息

  • 响应参数

    返回状态码为 200: successful operation。

    表2 响应Body参数列表

    名称

    类型

    描述

    vpn_connection

    ResponseVpnConnection object

    vpn_connection对象。

    request_id

    String

    请求ID。

    表3 ResponseVpnConnection

    名称

    类型

    描述

    id

    String

    • 功能说明:VPN连接ID。
    • 格式:36位UUID。

    name

    String

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

    status

    String

    • 功能说明:VPN连接状态。
    • 取值范围:

      ERROR:异常。

      ACTIVE:正常。

      DOWN:未连接。

      PENDING_CREATE:创建中。

      PENDING_UPDATE:更新中。

      PENDING_DELETE:删除中。

      FREEZED:冻结中。

      UNKNOWN:未知。

    vgw_id

    String

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

    vgw_ip

    String

    • 功能说明: VPN网关EIP的ID或接入私网IP。
    • 格式:36位UUID或点分十进制IPv4地址(如192.168.45.7)。

    style

    String

    • 功能说明:连接模式。
    • 取值范围:

      POLICY: 策略模式。

      STATIC: 静态路由模式。

      BGP: bgp路由模式。

      POLICY-TEMPLATE: 策略模板模式。

    cgw_id

    String

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

    peer_subnets

    Array of String

    IPv4对端子网。当VPN网关的关联模式为ER并且style字段为BGP或POLICY、或VPN网关的IP协议版本号为IPv6时不返回。

    peer_subnets_v6

    Array of String

    IPv6对端子网。当VPN网关的关联模式为ER并且style字段为BGP或POLICY、或VPN网关的IP协议版本号为IPv4时不返回。

    tunnel_local_address

    String

    路由模式下配置在VPN网关上的tunnel接口地址。仅当style为STATIC或BGP时有效。

    tunnel_peer_address

    String

    路由模式下配置在用户侧设备上的tunnel接口地址。仅当style为STATIC或BGP时有效。

    enable_nqa

    Boolean

    • 功能说明:开启NQA检测。仅当style为STATIC时返回。
    • 取值范围:true,false。

    enable_hub

    Boolean

    • 功能说明:开启分支互联。仅当style为BGP时返回。
    • 取值范围:true,false。

    policy_rules

    Array of PolicyRule objects

    IPv4策略模式的策略规则组。仅当style为POLICY且VPN网关的IP协议版本号为IPv4时返回实际的策略规则组。

    policy_rules_v6

    Array of PolicyRule objects

    IPv6策略模式的策略规则组。仅当style为POLICY且VPN网关的IP协议版本号为IPv6时返回实际的策略规则组。

    ikepolicy

    IkePolicy object

    ike策略对象。

    ipsecpolicy

    IpsecPolicy object

    ipsec策略对象。

    created_at

    String

    • 创建时间。
    • UTC时间格式:yyyy-MM-ddTHH:mm:ssZ。

    updated_at

    String

    • 最后一次更新时间。
    • UTC时间格式:yyyy-MM-ddTHH:mm:ssZ。

    enterprise_project_id

    String

    • 功能说明:企业项目ID。
    • 格式:36位UUID。与vgw_id所标识VPN网关的企业项目ID一致。

    connection_monitor_id

    String

    • 功能说明:VPN连接监控ID。仅当VPN连接下创建有连接监控时返回。
    • 格式:36位UUID。

    ha_role

    String

    • 功能说明:主备模式VPN网关下的连接时,'master'表示主连接,'slave'表示备连接。双活模式下的连接ha_role都是'master'。
    • 默认值:master

    tags

    Array of VpnResourceTag objects

    标签列表。

    表4 PolicyRule

    名称

    类型

    描述

    rule_index

    Integer

    • 功能说明:规则ID。
    • 取值范围:0-50。

    source

    String

    源地址网段。

    destination

    Array of String

    目的地址网段。单个IPv4网段格式示例:192.168.52.0/24。每个PolicyRule最多返回50个。

    表5 IkePolicy

    名称

    类型

    描述

    ike_version

    String

    • 功能说明:IKE版本号。
    • 取值范围:v1, v2。

    phase1_negotiation_mode

    String

    • 功能说明:协商模式。仅当IKE版本为v1时返回。
    • 取值范围:

      main:主模式,协商过程安全性高。

      aggressive:野蛮模式,协商快速且协商成功率高。

    authentication_algorithm

    String

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

    encryption_algorithm

    String

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

    dh_group

    String

    • 功能说明:第一阶段密钥交换使用的DH组,当VPN网关flavor为GM时不返回。
    • 取值范围:group1,group2,group5,group14,group15,group16,group19,group20,group21。

    authentication_method

    String

    • 功能说明:ike协商时的认证方法。
    • 取值范围:

      pre-share:预共享密钥。

      digital-envelope-v2:国密数字信封。

    lifetime_seconds

    Integer

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

    local_id_type

    String

    • 功能说明:本端ID类型,当VPN网关flavor为GM时不返回。
    • 取值范围:
      • ip。
      • fqdn。

    local_id

    String

    本端ID。当local_id_type为ip时返回创建或更新VPN连接时指定的本端ID,如果未指定则返回VPN连接所使用的VPN网关IP;当local_id_type为fqdn时返回创建或更新VPN连接时指定的本端ID。

    当VPN网关flavor为GM时不返回。

    peer_id_type

    String

    • 功能说明:对端ID类型,当VPN网关flavor为GM时不返回。
    • 取值范围:
      • ip。
      • fqdn。

    peer_id

    String

    对端ID。当peer_id_type为ip时返回创建或更新VPN连接时指定的对端ID,如果未指定则返回对端网关的IP;当peer_id_type为fqdn时返回创建或更新VPN连接时指定的对端ID。

    当VPN网关flavor为GM时不返回。

    dpd

    Dpd object

    对等体存活检测对象。

    表6 Dpd

    名称

    类型

    描述

    timeout

    Integer

    • 功能说明:对等体存活检测报文重传间隔。
    • 取值范围:2-60,单位:秒。

    interval

    Integer

    • 功能说明:对等体存活检测空闲时间。
    • 取值范围:10-3600,单位:秒。

    msg

    String

    • 功能说明:对等体存活检测报文格式。
    • 取值范围:

      seq-hash-notify:指定DPD报文中的载荷顺序是hash-notify。

      seq-notify-hash:指定DPD报文中的载荷顺序是notify-hash。

    表7 IpsecPolicy

    名称

    类型

    描述

    authentication_algorithm

    String

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

    encryption_algorithm

    String

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

    pfs

    String

    • 功能说明:PFS使用的DH密钥组,当VPN网关flavor为GM时不返回。
    • 取值范围:group1,group2,group5,group14,group15,group16,group19,group20,group21,disable。

    transform_protocol

    String

    • 功能说明:传输协议。
    • 取值范围:

      esp:封装安全协议。

    lifetime_seconds

    Integer

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

    encapsulation_mode

    String

    • 功能说明:报文封装模式。
    • 取值范围:

      tunnel:隧道模式。

    表8 VpnResourceTag

    名称

    类型

    描述

    key

    String

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

    value

    String

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

    名称

    类型

    描述

    peer_ip_address

    String

    BGP邻居地址。

    peer_asn

    Integer

    BGP邻居的BGP自治域编号。

    state

    String

    邻居状态。

    state_duration

    String

    连接持续时间。

    num_received_routes

    Integer

    已收到的路由数。

    num_message_received

    Integer

    已收到的消息数。

    num_message_sent

    Integer

    已发送的消息数。

  • 响应样例
    {
        "vpn_connection": {
            "id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3",
            "name": "vpn-1655",
            "status": "DOWN",
            "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d",
            "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde",
            "style": "POLICY",
            "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d",
            "peer_subnets": ["192.168.0.0/24"],
            "tunnel_local_address": "169.254.56.225/30",
            "tunnel_peer_address": "169.254.56.226/30",
            "policy_rules": [{
                "rule_index": 1,
                "source": "10.0.0.0/24",
                "destination": [
                    "192.168.0.0/24"
                ]
            }],
            "ikepolicy": {
                "ike_version": "v2",
                "authentication_algorithm": "sha2-256",
                "encryption_algorithm": "aes-128",
                "dh_group": "group15",
                "authentication_method": "pre-share",
                "lifetime_seconds": 86400,
                "local_id_type": "ip",
                "local_id": "10.***.***.134",
                "peer_id_type": "ip",
                "peer_id": "88.***.***.164",
                "dpd": {
                    "timeout": 15,
                    "interval": 30,
                    "msg": "seq-hash-notify"
                }
            },
            "ipsecpolicy": {
                "authentication_algorithm": "sha2-256",
                "encryption_algorithm": "aes-128",
                "pfs": "group15",
                "transform_protocol": "esp",
                "lifetime_seconds": 3600,
                "encapsulation_mode": "tunnel"
            },
            "created_at": "2022-11-26T13:41:34.626Z",
            "updated_at": "2022-11-26T13:41:34.626Z",
            "enterprise_project_id": "0",
            "ha_role":"master",
            "tags": [],
            "policy_rules_v6": [],
            "eip_id": "07f1efbf-01f5-4231-b22c-171005a352d4",
            "type": "ROUTE",
            "route_mode": "BGP"
        },
        "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae"
    }

状态码

请参见状态码

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

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容