Help Center/ Virtual Private Network/ API Reference (Ankara Region)/ API/ Enterprise Edition VPN API/ VPN Gateway/ Querying a Specified VPN Gateway
Updated on 2024-11-15 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying a Specified VPN Gateway

Function

This API is used to query a VPN gateway with a specified gateway ID.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

String

Yes

Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID.

vgw_id

String

Yes

Specifies a VPN gateway ID.

Request

  • Request parameters

    None

  • Example request 
    GET https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id}

Response

  • Response parameters

    Returned status code 200: successful query

    Table 2 Parameters in the response body

    Parameter

    Type

    Description

    vpn_gateway

    ResponseVpnGateway object

    Specifies the VPN gateway object.

    request_id

    String

    Specifies a request ID.
    Table 3 ResponseVpnGateway

    Parameter

    Type

    Description

    id

    String
    • Specifies a VPN gateway ID.
    • The value is a UUID containing 36 characters.

    name

    String
    • Specifies the name of a VPN gateway.
    • The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), hyphens (-), and periods (.).

    network_type

    String
    • Specifies the network type of the VPN gateway.
    • The value can be public or private.
    • The default value is public.

    status

    String
    • Specifies the status of the VPN gateway.
    • Value range:

      PENDING_CREATE: creating

      PENDING_UPDATE: updating

      PENDING_DELETE: deleting

      ACTIVE: normal

      FAULT: abnormal

      FREEZED: frozen

    attachment_type

    String
    • Specifies the association mode.
    • The value can be vpc or er.

    certificate_id

    String
    • Specifies a certificate ID.
    • The value is a UUID containing 36 characters.

    vpc_id

    String

    Specifies the ID of the service VPC associated with the VPN gateway. This parameter is available only when attachment_type is set to vpc.

    local_subnets

    Array of String

    Specifies a local subnet. This subnet is a cloud-side subnet that needs to communicate with an on-premises network through a VPN. An example subnet is 192.168.52.0/24. This parameter is returned only when attachment_type is set to vpc.

    connect_subnet

    String

    Specifies the ID of the VPC subnet used by the VPN gateway.

    bgp_asn

    Long

    Specifies the BGP AS number of the VPN gateway.

    flavor

    String
    • Specifies the specification of the VPN gateway.
    • Value range:

      Professional1: The maximum forwarding bandwidth is 300 Mbit/s.

      Professional2: The maximum forwarding bandwidth is 1 Gbit/s.

      GM: The maximum forwarding bandwidth is 500 Mbit/s.

    availability_zone_ids

    Array of String

    Specifies the AZ where the VPN gateway is deployed. This parameter is available when an AZ is specified. If no AZ is specified, this parameter is available only when the VPN gateway is in ACTIVE state.

    connection_number

    Integer

    Specifies the maximum number of VPN connections supported for the VPN gateway.

    used_connection_number

    Integer

    Specifies the number of VPN connections that have been used by the VPN gateway.

    used_connection_group

    Integer

    Specifies the number of VPN connection groups that have been used by the VPN gateway. A connection group consists of two connections between a customer gateway and a VPN gateway. By default, 10 VPN connection groups are included free of charge with the purchase of a VPN gateway.

    enterprise_project_id

    String
    • Specifies an enterprise project ID.
    • The value is a UUID containing 36 characters. If no enterprise project ID is specified during VPN gateway creation, 0 is returned, indicating that the resource belongs to the default enterprise project.

      Note that 0 is not the ID of an existing enterprise project.

    eip1

    ResponseEip object

    Specifies the first EIP of the VPN gateway using the active-active mode or the active EIP of the VPN gateway using the active/standby mode. This parameter is available when the VPN gateway is in ACTIVE state.

    eip2

    ResponseEip object

    Specifies the second EIP of the VPN gateway using the active-active mode or the standby EIP of the VPN gateway using the active/standby mode. This parameter is available when the VPN gateway is in ACTIVE state.

    created_at

    String
    • Specifies the time when the VPN gateway is created. This parameter is available when the VPN gateway is in ACTIVE state.
    • The UTC time format is yyyy-MM-ddTHH:mm:ssZ.

    updated_at

    String
    • Specifies the last update time. This parameter is available when the VPN gateway is in ACTIVE state.
    • The UTC time format is yyyy-MM-ddTHH:mm:ssZ.

    access_vpc_id

    String
    • Specifies the ID of the access VPC used by the VPN gateway.
    • The value is a UUID containing 36 characters.

    access_subnet_id

    String
    • Specifies the ID of the subnet in the access VPC used by the VPN gateway.
    • The value is a UUID containing 36 characters.

    access_private_ip_1

    String

    Specifies a private IP address used by the VPN gateway to connect to a customer gateway when the network type is private network. This address is the first private IP address of the VPN gateway in active-active mode or the active private IP address of the VPN gateway in the active/standby mode.

    An example is 192.168.52.9. This parameter is available only when network_type is set to private.

    access_private_ip_2

    String

    Specifies a private IP address used by the VPN gateway to connect to a customer gateway when the network type is private network. This address is the second private IP address of the VPN gateway in active-active mode or the standby private IP address of the VPN gateway in the active/standby mode.

    An example is 192.168.52.9. This parameter is available only when network_type is set to private.

    certificate_id

    String
    • Specifies the ID of the certificate used by the VPN gateway. This parameter is available only when flavor is set to GM.
    • The value is a UUID containing 36 characters.

    ha_mode

    String
    • Specifies the HA mode of the gateway. The value can be active-active or active-standby.
    • Value range: active-active, active-standby
    • Default value: active-active

    tags

    Array of VpnResourceTag objects

    Specifies a tag list.
    Table 4 ResponseEip

    Parameter

    Type

    Description

    id

    String
    • Specifies an EIP ID.
    • The value is a UUID containing 36 characters. If the default enterprise project is used, 0 is returned.

    ip_version

    Integer
    • Specifies the EIP version.
    • The value can only be 4, indicating IPv4 address.

    ip_billing_info

    String
    • Specifies the EIP order information.
    • The value is in the format of order_id:product_id:region_id:project_id, for example:

      CS22********LIBIV:00301-******-0--0:br-iaas-odin1:0605768a************c006c7e484aa

    type

    String
    • Specifies the EIP type.
    • For the value range, see the type field in "Assigning an EIP" in the Elastic IP API Reference.

    ip_address

    String
    • Specifies an EIP, that is, a public IPv4 address.
    • The value is an IPv4 address, for example, 88.***.***.11.

    charge_mode

    String
    • Specifies the billing mode of EIP bandwidth.
    • Value range:

      bandwidth: billed by bandwidth

      traffic: billed by traffic

    bandwidth_size

    Integer
    • Specifies the bandwidth (Mbit/s) of an EIP. The maximum EIP bandwidth varies according to regions and depends on the EIP service. You can submit a service ticket to increase the maximum EIP bandwidth under your account.
    • The value ranges from 1 to 1000. For details, see the EIP documentation.

    bandwidth_name

    String
    • Specifies the bandwidth name of an EIP.
    • The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), hyphens (-), and periods (.).

    bandwidth_billing_info

    String
    • Specifies the EIP bandwidth order information.
    • The value is in the format of order_id:product_id:region_id:project_id, for example:

      CS22********LIBIV:00301-******-0--0:br-iaas-odin1:0605768a************c006c7e484aa
    Table 5 PolicyTemplate

    Parameter

    Type

    Description

    ike_policy

    IkePolicy object

    Specifies the IKE policy object.

    ipsec_policy

    IpsecPolicy object

    Specifies the IPsec policy object.
    Table 6 IkePolicy

    Parameter

    Type

    Description

    encryption_algorithm

    String
    • Specifies an encryption algorithm.
    • The value can be aes-256-gcm-16, aes-128-gcm-16, aes-256, aes-192, or aes-128.

    dh_group

    String
    • Specifies the DH group used for key exchange in phase 1.
    • The value can be group14, group15, group16, group19, group20, group21, or disable.

    authentication_algorithm

    String
    • Specifies an authentication algorithm.
    • The value can be sha2-512, sha2-384, or sha2-256.

    lifetime_seconds

    Integer
    • Specifies the SA lifetime. When the lifetime expires, an IKE SA is automatically updated.
    • The value ranges from 60 to 604800, in seconds.
    Table 7 IpsecPolicy

    Parameter

    Type

    Description

    authentication_algorithm

    String
    • Specifies an authentication algorithm.
    • The value can be sha2-512, sha2-384, or sha2-256.

    encryption_algorithm

    String
    • Specifies an encryption algorithm.
    • The value can be aes-256-gcm-16, aes-128-gcm-16, aes-256, aes-192, or aes-128.

    pfs

    String
    • Specifies the DH key group used by PFS.
    • The value can be group14, group15, group16, group19, group20, group21, or disable.

    lifetime_seconds

    Integer
    • Specifies the lifetime of a tunnel established over an IPsec connection.
    • The value ranges from 30 to 604800, in seconds.
    Table 8 VpnResourceTag

    Parameter

    Type

    Description

    key

    String
    • Specifies a tag key.
    • The value is a string of 1 to 128 characters that can contain digits, letters, Spanish characters, Portuguese characters, spaces, and special characters (_ . : = + - @).

    value

    String
    • Specifies a tag value.
    • The value is a string of 0 to 255 characters that can contain digits, letters, Spanish characters, Portuguese characters, spaces, and special characters (_ . : = + - @).
  • Example responses
    1. Example response to the request for querying a private VPN gateway associated with a VPC 
      {
    "vpn_gateway": {
        "id": "66ddeacb-demo-a8df-va86-9a414b5bd7d5",
        "name": "vpngw-5bd6",
        "network_type": "private",
        "status": "ACTIVE",
        "attachment_type": "vpc",
        "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"
}

Status Codes

For details, see Status Codes.

Parent topic: VPN Gateway