Tüm Ürünler
Search
Belge Merkezi

:DescribeVcoRouteEntries

Son Güncelleme:Oct 13, 2026

Bir IPsec-VPN bağlantısının rotaları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:DescribeVcoRouteEntries

list

*VpnConnections

acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

IPsec-VPN bağlantısının bölge kimliği.

En son bölge listesini sorgulamak için DescribeRegions işlemini çağırabilirsiniz.

cn-hangzhou

VpnConnectionId

string

Yes

IPsec-VPN bağlantısının kimliği.

vco-p0w2jpkhi2eeop6q6****

RouteEntryType

string

No

Rotanın türü. Geçerli değerler:

  • custom (varsayılan): hedef rota.

  • bgp: BGP rotası.

custom

PageNumber

integer

No

Sayfa numarası. Varsayılan değer: 1.

1

PageSize

integer

No

Her sayfada döndürülecek giriş sayısı. Varsayılan değer: 10. Geçerli değerler: 1 ile 50 arası.

10

ClientToken

string

No

İsteğin idempotent olmasını sağlamak için kullanılan istemci belirteci.

Değeri oluşturmak için istemciyi kullanabilirsiniz, ancak bu değerin farklı istekler arasında benzersiz olduğundan emin olmalısınız. İstemci belirteci yalnızca ASCII karakterleri içerebilir.

Not

Bu parametreyi belirtmezseniz, sistem otomatik olarak API isteğinin RequestId değerini ClientToken olarak kullanır. Her API isteğinin RequestId değeri benzersizdir.

123e4567-e89b-12d3-a456-4266****

Response elements

Element

Type

Description

Example

object

Yanıt.

PageNumber

integer

Sayfa numarası.

1

PageSize

integer

Her sayfada döndürülen giriş sayısı.

10

RequestId

string

İstek kimliği.

E18980E8-C8C2-31BD-8156-AE2BBDEC87E1

TotalCount

integer

Toplam giriş sayısı.

1

VcoRouteEntries

array<object>

Rota listesi.

object

Rota.

AsPath

string

BGP rotasının geçtiği otonom sistem (AS) numaralarının listesi.

[12000]

Community

string

BGP rotası tarafından taşınan topluluk değeri.

65535:65510

CreateTime

integer

Hedef rotanın oluşturulduğu zaman damgası.

Zaman damgası UNIX zaman biçimini takip eder. 1 Ocak 1970 00:00:00 UTC'den bu yana geçen toplam saniye sayısını temsil eder.

1658217008000

NextHop

string

Rotanın sonraki atlama noktası.

vco-p0w2jpkhi2eeop6q6****

NextHopTunnelIdList

array

Sonraki atlama tünellerinin listesi.

Not
  • Bu bilgiler yalnızca çift tünel modundaki IPsec-VPN bağlantıları için döndürülür.

  • Tünel bilgileri yalnızca tünel durumu Phase 2 negotiation succeeded olduğunda döndürülür.

string

Tünel kimliği.

tun-0jothw962cp3bvhbw****

PrefixListId

string

Ön ek listesinin örnek kimliği.

pl-m5estsqsdqwg88hjf****

RouteDest

string

Rotanın hedef CIDR bloğu.

192.168.10.0/24

RouteEntryType

string

Rotanın türü.

  • custom: Rota bir hedef rotadır.

  • bgp: Rota bir BGP rotasıdır.

custom

Source

string

BGP rotasının kaynağı.

  • CLOUD: BGP rotası, IPsec-VPN bağlantısı tarafından bir transit yönlendiriciden öğrenilir.

  • VPN_BGP: BGP rotası, IPsec-VPN bağlantısı tarafından şirket içi veri merkezinden öğrenilir.

CLOUD

State

string

Rotanın durumu.

  • published: Hedef rota transit yönlendiriciye yayımlanır.

  • Active: BGP rotası kullanılabilir.

published

VpnConnectionId

string

IPsec-VPN bağlantısının kimliği.

vco-p0w2jpkhi2eeop6q6****

Weight

integer

Hedef rotanın ağırlığı.

Not

Bu parametre etkili değildir.

100

VpnRouteCounts

array<object>

Çift tünel modundaki IPsec-VPN bağlantısı için rota istatistikleri.

Not

Bu bilgiler yalnızca çift tünel modundaki IPsec-VPN bağlantıları için döndürülür.

object

Rota istatistikleri.

RouteCount

integer

Rota sayısı.

3

RouteEntryType

string

Rotanın türü.

  • custom: hedef rota.

  • bgp: BGP rotası.

bgp

Source

string

BGP rotasının kaynağı.

  • CLOUD: BGP rotası, IPsec-VPN bağlantısı tarafından bir transit yönlendiriciden öğrenilir.

  • VPN_BGP: BGP rotası, IPsec-VPN bağlantısı tarafından şirket içi veri merkezinden öğrenilir.

VPN_BGP

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "E18980E8-C8C2-31BD-8156-AE2BBDEC87E1",
  "TotalCount": 1,
  "VcoRouteEntries": [
    {
      "AsPath": "[12000]",
      "Community": "65535:65510",
      "CreateTime": 1658217008000,
      "NextHop": "vco-p0w2jpkhi2eeop6q6****",
      "NextHopTunnelIdList": [
        "tun-0jothw962cp3bvhbw****"
      ],
      "PrefixListId": "pl-m5estsqsdqwg88hjf****",
      "RouteDest": "192.168.10.0/24",
      "RouteEntryType": "custom",
      "Source": "CLOUD",
      "State": "published",
      "VpnConnectionId": "vco-p0w2jpkhi2eeop6q6****",
      "Weight": 100
    }
  ],
  "VpnRouteCounts": [
    {
      "RouteCount": 3,
      "RouteEntryType": "bgp",
      "Source": "VPN_BGP"
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 IllegalParam.RouteEntryType The specified RouteEntryType is invalid. Belirtilen rota türü geçersiz.
400 Vco.StatusNotSupport The current VPN connection state does not support this operation. Mevcut örnek durumu bu işlemi desteklemez.
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. Belirtilen kaynağı yönetmek için gerekli izinlere sahip değilsiniz. Gerekli izinler için başvurun ve tekrar deneyin.
404 InvalidVpnConnectionInstanceId.NotFound The specified vpn connection instance id does not exist. Belirtilen VPN bağlantısı mevcut değil. VPN bağlantısı kimliğinin doğru olup olmadığını kontrol edin.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.