Tüm Ürünler
Search
Belge Merkezi

:DescribeVpnAttachments

Son Güncelleme:Oct 02, 2026

Geçiş yönlendirici örnekleriyle ilişkili IPsec-VPN bağlantılarının yapılandırma bilgilerini 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:DescribeVpnAttachments

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.

Bölge kimliğini sorgulamak için DescribeRegions işlemini çağırabilirsiniz.

cn-hangzhou

PageNumber

integer

No

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

1

PageSize

integer

No

Sayfalama kullanılırken sayfa başına düşen giriş sayısı. Varsayılan değer: 10. Geçerli değerler: 1 ile 50 arası.

10

VpnConnectionId

string

No

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

Not

IPsec-VPN bağlantı kimliğini belirtmezseniz, sistem mevcut bölgedeki geçiş yönlendirici örnekleriyle ilişkili tüm IPsec-VPN bağlantılarını sorgular.

vco-p0w2jpkhi2eeop6q6****

AttachType

string

No

IPsec-VPN bağlantısının eklendiği kaynağın türü. Varsayılan değer: CEN.

Değer yalnızca CEN olabilir; bu, sistemin geçiş yönlendirici örnekleriyle ilişkili IPsec-VPN bağlantılarını sorguladığını gösterir.

CEN

Response elements

Element

Type

Description

Example

object

Yanıt parametreleri.

RequestId

string

İstek kimliği.

9F0725BB-186A-3564-91C3-AAE48042F853

PageSize

integer

Sayfalama kullanılırken sayfa başına düşen giriş sayısı.

10

PageNumber

integer

Sayfa numarası.

1

TotalCount

integer

Döndürülen toplam giriş sayısı.

1

VpnAttachments

array<object>

Geçiş yönlendirici örnekleriyle ilişkili IPsec-VPN bağlantılarının listesi.

array<object>

Bir geçiş yönlendirici örneğiyle ilişkili IPsec-VPN bağlantısı hakkındaki bilgiler.

InstanceId

string

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

vco-p0w2jpkhi2eeop6q6****

Name

string

IPsec-VPN bağlantısının adı.

nametest1

Description

string

IPsec-VPN bağlantısının açıklaması.

desctest

AttachType

string

IPsec-VPN bağlantısının eklendiği kaynağın türü. Değer CEN'dir; bu, IPsec-VPN bağlantısının bir geçiş yönlendirici örneğiyle ilişkili olduğunu gösterir.

CEN

TransitRouterId

string

IPsec-VPN bağlantısının eklendiği ileri yönlendirme vRouter'ının örnek kimliği.

tr-p0wkh4yryb1dnanqw****

TransitRouterName

string

Geçiş yönlendirici örneğinin adı.

nametest2

CrossAccountAuthorized

boolean

IPsec-VPN bağlantısının farklı bir Alibaba Cloud hesabına ait bir geçiş yönlendirici örneğiyle ilişkili olup olmadığını gösterir.

  • true: IPsec-VPN bağlantısı, çapraz hesaplı bir geçiş yönlendirici örneğiyle ilişkilidir.

  • false: IPsec-VPN bağlantısı, çapraz hesaplı bir geçiş yönlendirici örneğiyle ilişkili değildir.

false

Tag

string

IPsec-VPN bağlantısının sistem etiketleri.

IPsec-VPN bağlantısının BGP'yi destekleyip desteklemediğini kontrol etmek için sistem etiketlerini kullanabilirsiniz. Diğer özellikleri yok sayabilirsiniz.

BGPSupport: IPsec-VPN bağlantısının BGP'yi destekleyip desteklemediğini gösterir.

  • true: Desteklenir.

  • false: Desteklenmez.

{\"description\":\"forwarding1.7.22\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"BGPSupport\":\"true\",\"IDaaSNewVersion\":\"true\"}

Tags

array<object>

IPsec-VPN bağlantısıyla ilişkili etiketlerin listesi.

object

Etiket bilgileri.

Key

string

Etiket anahtarı.

TagKey

Value

string

Etiket değeri.

TagValue

TunnelBandwidth

string

Tek bir VPN tünelinin bant genişliği teknik özellikleri. Geçerli değerler: Standard (default): Standart. Varsayılan bant genişliği 1 Gbit/s'dir. Large: Büyük. Varsayılan bant genişliği 3 Gbit/s'dir.

Standard

Examples

Success response

JSON format

{
  "RequestId": "9F0725BB-186A-3564-91C3-AAE48042F853",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 1,
  "VpnAttachments": [
    {
      "InstanceId": "vco-p0w2jpkhi2eeop6q6****",
      "Name": "nametest1",
      "Description": "desctest",
      "AttachType": "CEN",
      "TransitRouterId": "tr-p0wkh4yryb1dnanqw****",
      "TransitRouterName": "nametest2",
      "CrossAccountAuthorized": false,
      "Tag": "{\\\"description\\\":\\\"forwarding1.7.22\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"BGPSupport\\\":\\\"true\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
      "Tags": [
        {
          "Key": "TagKey",
          "Value": "TagValue"
        }
      ],
      "TunnelBandwidth": "Standard"
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 Forbidden.TagKey.Duplicated The specified tag key already exists. The tag resources are duplicate.
400 SizeLimitExceeded.TagNum The maximum number of tags is exceeded. The number of tags has reached the upper limit.
400 InvalidParameter.TagValue The specified parameter TagValue is invalid. The error message returned because the specified tag value is invalid.
400 InvalidParameter.TagKey The specified parameter TagKey is invalid. The error message returned because the specified tag key is invalid.
400 Duplicated.TagKey The specified parameter TagKey is duplicated. The error message returned because the specified tag key already exists.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.