虚拟专用网络 VPN-查询P2C VPN网关:响应消息

时间:2024-11-30 08:55:24

响应消息

  • 响应参数

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

    表2 响应Body参数列表

    名称

    类型

    描述

    p2c_vpn_gateway

    p2c_vpn_gateway

    object

    vpn_gateway对象

    request_id

    String

    请求ID

    表3 p2c_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:删除中

      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:冻结不可删除

    created_at

    String

    • 功能说明:创建时间
    • UTC时间格式:yyyy-MM-ddTHH:mm:ssZ

    updated_at

    String

    • 功能说明:最后一次更新时间
    • UTC时间格式:yyyy-MM-ddTHH:mm:ssZ
    表4 ResponseEipInfo

    名称

    类型

    描述

    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,如:

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

    表5 VpnResourceTag

    名称

    类型

    描述

    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,
            "enterprise_project_id": "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"
    }
support.huaweicloud.com/api-vpn/vpn_api_0072.html