Tüm Ürünler
Search
Belge Merkezi

:DescribeVpnGateway

Son Güncelleme:Oct 02, 2026

DescribeVpnGateway API'sini çağırarak belirtilen bir VPN ağ geçidinin ayrıntılarını sorgular.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeVpnGateway

get

*VpnGateway.

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

VPN ağ geçidinin bölge kimliği.

Bölge kimliğini almak için DescribeRegions API'sini çağırabilirsiniz.

cn-hangzhou

VpnGatewayId

string

Yes

VPN ağ geçidi örneğinin kimliği.

vpn-bp1r3v1xqkl0w519g****

IncludeReservationData

boolean

No

Bekleyen sipariş verilerinin dahil edilip edilmeyeceğini belirtir. Geçerli değerler:

  • false (varsayılan): Bekleyen sipariş verilerini içermez.

  • true: Bekleyen sipariş verilerini içerir.

true

Response elements

Element

Type

Description

Example

object

Yanıt parametreleri.

VpnType

string

VPN ağ geçidinin türü. Değer: Standart bir türü belirten Normal.

Normal

Status

string

VPN ağ geçidinin durumu. Geçerli değerler:

  • init: Başlatılıyor.

  • provisioning: Hazırlanıyor.

  • active: Normal.

  • updating: Güncelleniyor.

  • deleting: Siliniyor.

init

VpcId

string

VPN ağ geçidinin ait olduğu VPC'nin kimliği.

vpc-bp19m2yx1m5q0avyq****

SslMaxConnections

integer

Eşzamanlı SSL-VPN bağlantılarının maksimum sayısı.

5

Spec

string

VPN ağ geçidinin bant genişliği teknik özelliği. Birim: Mbps.

5

InternetIp

string

  • VPN ağ geçidi örneğinin tek tünelli modda IPsec-VPN bağlantıları oluşturmayı desteklediği senaryolarda, bu adres VPN ağ geçidi örneğinin IP adresidir ve IPsec-VPN bağlantıları veya SSL-VPN bağlantıları oluşturmak için kullanılabilir.

  • VPN ağ geçidi örneğinin çift tünelli modda IPsec-VPN bağlantıları oluşturmayı desteklediği senaryolarda, bu adres IPsec-VPN bağlantıları oluşturmak için kullanılan ilk IP adresidir ve SSL-VPN bağlantıları oluşturmak için kullanılamaz.

    VPN ağ geçidi örneğinin çift tünelli modda IPsec-VPN bağlantıları oluşturmayı desteklediği senaryolarda, sistem çift tünelli modda IPsec-VPN bağlantıları oluşturmak için VPN ağ geçidi örneğine iki IPsec adresi atar.

47.22.XX.XX

CreateTime

integer

VPN ağ geçidinin oluşturulduğu zaman damgası. Birim: milisaniye.

Zaman damgası Unix formatındadır ve 1 Ocak 1970 00:00:00 UTC'den VPN ağ geçidinin oluşturulma zamanına kadar geçen toplam milisaniye sayısını temsil eder.

1495382400000

AutoPropagate

boolean

VPN ağ geçidi için otomatik rota yayma özelliğinin etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

  • true: Etkin.

  • false: Devre dışı.

true

ChargeType

string

Faturalandırma yöntemi. Geçerli değerler:

POSTPAY: Kullandıkça öde.

China site example value: Prepay, International site example value: POSTPAY

VpnGatewayId

string

VPN ağ geçidi örneğinin kimliği.

vpn-bp1r3v1xqkl0w519g****

Tag

string

VPN ağ geçidinin sistem tarafından oluşturulan etiketleri.

  • VpnEnableBgp: VPN ağ geçidinin BGP özelliğini destekleyip desteklemediğini gösterir.
    • true: Desteklenir.

    • false: Desteklenmez.

  • VisuallySsl: VPN ağ geçidinin SSL istemci bağlantı bilgilerinin görüntülenmesini destekleyip desteklemediğini gösterir.
    • true: Desteklenir.

    • false: Desteklenmez.

  • PbrPriority: VPN ağ geçidinin ilke tabanlı rotalar için ilke önceliklerini yapılandırmayı destekleyip desteklemediğini gösterir.
    • true: Desteklenir.

    • false: Desteklenmez.

  • VpnNewImage: VPN ağ geçidinin yeni nesil bir VPN ağ geçidi olup olmadığını gösterir.
    • true: Evet.

    • false: Hayır.

  • description: Yalnızca dahili sistem amaçları için kullanılan VPN ağ geçidinin açıklaması.

  • VpnVersion: VPN ağ geçidinin sürüm numarası.

  • IDaaSNewVersion: VPN ağ geçidinin EIAM 2.0 örneklerine bağlanmayı destekleyip desteklemediğini gösterir.
    • true: Desteklenir.

    • false: Desteklenmez.

{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"转发1.3.24\",\"VpnVersion\":\"v1.2.4\",\"IDaaSNewVersion\":\"true\"}

IpsecVpn

string

IPsec-VPN özelliğinin etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

  • enable: Etkin.

  • disable: Devre dışı.

enable

EndTime

integer

VPN ağ geçidinin sona erme zaman damgası. Birim: milisaniye.

Zaman damgası Unix formatındadır ve 1 Ocak 1970 00:00:00 UTC'den VPN ağ geçidinin sona erme zamanına kadar geçen toplam milisaniye sayısını temsil eder.

1544666102000

VSwitchId

string

VPN ağ geçidinin ait olduğu vSwitch'in kimliği.

vsw-bp1dmzugdikc6hdgx****

RequestId

string

İstek kimliği.

27E4E088-8DE0-4672-BF5C-0A412389DB9E

Description

string

VPN ağ geçidinin açıklaması.

vpngatewaydescription

EnableBgp

boolean

VPN ağ geçidinin BGP özelliği durumu. Geçerli değerler:

  • true: Etkin.

  • false: Devre dışı.

true

BusinessStatus

string

VPN ağ geçidinin faturalandırma durumu. Geçerli değerler:

  • Normal: Normal.

  • FinancialLocked: Ödeme gecikmesi nedeniyle kilitli.

Normal

SslVpn

string

SSL-VPN özelliğinin durumu. Geçerli değerler:

  • enable: Etkin.

  • disable: Devre dışı.

enable

Name

string

VPN ağ geçidinin adı.

vpngatewayname

ReservationData

object

Bekleyen sipariş verileri.

Not

Bu parametre yalnızca IncludeReservationData değeri true olarak ayarlandığında döndürülür.

Status

string

Bekleyen siparişin durumu. Geçerli değerler:

  • 1: Yenileme veya teknik özellik değişikliği ile yenileme siparişinin yürürlüğe girmediğini gösterir.

  • 2: Geçici yükseltme siparişinin yürürlüğe girdiğini gösterir. Geri yükleme zamanına ulaşıldıktan sonra sistem, VPN ağ geçidi teknik özelliğini geçici yükseltmeden önceki teknik özelliğe geri yükleyecektir. Bu durumda ReservationIpsec, ReservationMaxConnections, ReservationSpec ve ReservationSsl, VPN ağ geçidinin geçici yükseltmeden önceki teknik özelliklerini temsil eder.

1

ReservationOrderType

string

Bekleyen siparişin türü. Geçerli değerler:

  • RENEWCHANGE: Teknik özellik değişikliği ile yenileme.

  • TEMP_UPGRADE: Geçici yükseltme.

  • RENEW: Yenileme.

TEMP_UPGRADE

ReservationIpsec

string

Bekleyen siparişin IPsec-VPN özelliği durumu. Geçerli değerler:

  • enable: Etkin.

  • disable: Devre dışı.

enable

ReservationSpec

string

Bekleyen siparişin bant genişliği teknik özelliği. Birim: Mbps.

5

ReservationSsl

string

Bekleyen siparişin SSL-VPN özelliği durumu. Geçerli değerler:

  • enable: Etkin.

  • disable: Devre dışı.

enable

ReservationMaxConnections

integer

Bekleyen sipariş için eşzamanlı SSL-VPN bağlantılarının maksimum sayısı.

5

ReservationEndTime

string

Bekleyen sipariş türü TEMP_UPGRADE (geçici yükseltme) ise bu parametre geçici yükseltme için geri yükleme zamanını gösterir.

Bekleyen sipariş türü RENEWCHANGE (teknik özellik değişikliği ile yenileme) veya RENEW (yenileme) ise bu parametre yenileme veya teknik özellik değişikliği ile yenilemenin yürürlüğe girme zamanını gösterir.

2020-07-20T16:00:00Z

Tags

object

Tag

array<object>

VPN ağ geçidi örneğine bağlı etiketlerin listesi.

object

VPN ağ geçidi örneğine bağlı etiketlerin listesi.

Key

string

Etiket anahtarı.

aaa

Value

string

Etiket değeri.

bbb

NetworkType

string

VPN ağ geçidinin ağ türü.

  • public: Genel VPN ağ geçidi.

  • private: Özel VPN ağ geçidi.

public

DisasterRecoveryInternetIp

string

IPsec-VPN bağlantıları oluşturmak için sistem tarafından VPN ağ geçidi örneğine atanan ikinci IP adresi.

Bu parametre yalnızca çift tünelli modda IPsec-VPN bağlantıları oluşturmayı destekleyen VPN ağ geçidi örnekleri için döndürülür.

47.91.XX.XX

DisasterRecoveryVSwitchId

string

VPN ağ geçidi örneğiyle ilişkili ikinci vSwitch'in kimliği.

Bu parametre yalnızca çift tünelli modda IPsec-VPN bağlantıları oluşturmayı destekleyen VPN ağ geçidi örnekleri için döndürülür.

vsw-p0w95ql6tmr2ludkt****

SslVpnInternetIp

string

SSL-VPN bağlantıları için IP adresi.

Bu parametre yalnızca çift tünelli modda IPsec-VPN bağlantıları oluşturmayı destekleyen bir genel ağ VPN ağ geçidi örneğinde SSL-VPN etkinleştirildiğinde döndürülür.

47.74.XX.XX

ResourceGroupId

string

VPN ağ geçidinin ait olduğu kaynak grubunun kimliği.

Kaynak grubu bilgilerini sorgulamak için ListResourceGroups API'sini çağırabilirsiniz.

rg-acfmzs372yg****

EniInstanceIds

object

EniInstanceId

array

Sistem tarafından VPN ağ geçidi örneği için oluşturulan Elastik Ağ Arabirimlerinin (ENI) listesi.

string

ENI kimliği.

Bu parametre yalnızca çift tünelli modda IPsec-VPN bağlantıları oluşturmayı destekleyen VPN ağ geçidi örnekleri için döndürülür.

eni-7xvcxgmd4y2ypibn****

GatewayType

string

VPN ağ geçidi türü. Geçerli değerler:

  • Traditional: Hem IPsec hem de SSL özelliklerini kapsayan geleneksel VPN ağ geçidi.

  • Enhanced.SiteToSite: Yalnızca IPsec özelliklerini kapsayan gelişmiş siteden buluta VPN.

Enhanced.SiteToSite

Examples

Success response

JSON format

{
  "VpnType": "Normal",
  "Status": "init",
  "VpcId": "vpc-bp19m2yx1m5q0avyq****",
  "SslMaxConnections": 5,
  "Spec": "5",
  "InternetIp": "47.22.XX.XX",
  "CreateTime": 1495382400000,
  "AutoPropagate": true,
  "ChargeType": "中国站示例值:Prepay,国际站示例值:POSTPAY",
  "VpnGatewayId": "vpn-bp1r3v1xqkl0w519g****",
  "Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"转发1.3.24\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
  "IpsecVpn": "enable",
  "EndTime": 1544666102000,
  "VSwitchId": "vsw-bp1dmzugdikc6hdgx****",
  "RequestId": "27E4E088-8DE0-4672-BF5C-0A412389DB9E",
  "Description": "vpngatewaydescription",
  "EnableBgp": true,
  "BusinessStatus": "Normal",
  "SslVpn": "enable",
  "Name": "vpngatewayname",
  "ReservationData": {
    "Status": "1",
    "ReservationOrderType": "TEMP_UPGRADE",
    "ReservationIpsec": "enable",
    "ReservationSpec": "5",
    "ReservationSsl": "enable",
    "ReservationMaxConnections": 5,
    "ReservationEndTime": "2020-07-20T16:00:00Z"
  },
  "Tags": {
    "Tag": [
      {
        "Key": "aaa",
        "Value": "bbb"
      }
    ]
  },
  "NetworkType": "public",
  "DisasterRecoveryInternetIp": "47.91.XX.XX",
  "DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
  "SslVpnInternetIp": "47.74.XX.XX",
  "ResourceGroupId": "rg-acfmzs372yg****",
  "EniInstanceIds": {
    "EniInstanceId": [
      "eni-7xvcxgmd4y2ypibn****"
    ]
  },
  "GatewayType": "Enhanced.SiteToSite"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist.
403 Forbbiden.SubUser User not authorized to operate on the specified resource as your account is created by another user.
403 Forbidden User not authorized to operate on the specified resource.
404 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.