DescribeVpnAttachments - VPN Gateway - Alibaba Cloud Documentation Center

Mengkueri informasi konfigurasi koneksi IPsec-VPN yang dikaitkan dengan instans transit router.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeVpnAttachments

list

*VpnConnections

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID region koneksi IPsec-VPN. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID region.	cn-hangzhou
PageNumber	integer	No	Nomor halaman daftar. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman saat paginasi digunakan. Nilai default: 10. Nilai yang valid: 1 hingga 50.	10
VpnConnectionId	string	No	ID koneksi IPsec-VPN. Catatan Jika Anda tidak menentukan ID koneksi IPsec-VPN, sistem akan mengkueri informasi tentang semua koneksi IPsec-VPN yang dikaitkan dengan instans transit router di region saat ini.	vco-p0w2jpkhi2eeop6q6****
AttachType	string	No	Jenis resource tempat koneksi IPsec-VPN dilampirkan. Nilai default: CEN. Nilainya hanya dapat berupa CEN, yang menunjukkan bahwa sistem mengkueri koneksi IPsec-VPN yang dikaitkan dengan instans transit router.	CEN

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
RequestId	string	ID permintaan.	9F0725BB-186A-3564-91C3-AAE48042F853
PageSize	integer	Jumlah entri per halaman saat paginasi digunakan.	10
PageNumber	integer	Nomor halaman daftar.	1
TotalCount	integer	Jumlah total entri.	1
VpnAttachments	array<object>	Daftar koneksi IPsec-VPN yang dikaitkan dengan instans transit router.
	array<object>	Informasi tentang koneksi IPsec-VPN yang dikaitkan dengan instans transit router.
InstanceId	string	ID koneksi IPsec-VPN.	vco-p0w2jpkhi2eeop6q6****
Name	string	Nama koneksi IPsec-VPN.	nametest1
Description	string	Deskripsi koneksi IPsec-VPN.	desctest
AttachType	string	Jenis resource tempat koneksi IPsec-VPN dilampirkan. Nilainya adalah CEN, yang menunjukkan bahwa koneksi IPsec-VPN dikaitkan dengan instans transit router.	CEN
TransitRouterId	string	ID instans transit routing tempat koneksi IPsec-VPN dilampirkan.	tr-p0wkh4yryb1dnanqw****
TransitRouterName	string	Nama instans transit router.	nametest2
CrossAccountAuthorized	boolean	Menunjukkan apakah koneksi IPsec-VPN dikaitkan dengan instans transit router milik akun Alibaba Cloud yang berbeda. true: ya. false: tidak.	false
Tag	string	Tag sistem koneksi IPsec-VPN. Anda dapat menggunakan tag sistem untuk memeriksa apakah koneksi IPsec-VPN mendukung BGP. Anda tidak perlu memperhatikan properti lainnya. BGPSupport: menunjukkan apakah koneksi IPsec-VPN mendukung BGP. true: didukung. false: tidak didukung.	{\"description\":\"转发1.7.22\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"BGPSupport\":\"true\",\"IDaaSNewVersion\":\"true\"}
Tags	array<object>	Daftar tag yang dilampirkan ke koneksi IPsec-VPN.
	object	Informasi tag.
Key	string	Kunci tag.	TagKey
Value	string	Nilai tag.	TagValue
TunnelBandwidth	string	Spesifikasi bandwidth tunnel VPN tunggal. Nilai yang valid: Standard (default): standar. Bandwidth default adalah 1 Gbit/s. Large: besar. Bandwidth default adalah 3 Gbit/s.	Standard

Contoh

Respons sukses

JSONformat

{
  "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\\\":\\\"转发1.7.22\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"BGPSupport\\\":\\\"true\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
      "Tags": [
        {
          "Key": "TagKey",
          "Value": "TagValue"
        }
      ],
      "TunnelBandwidth": "Standard"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	Sumber daya tag duplikat.
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	Jumlah tag melebihi batas.
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	Parameter TagValue yang ditentukan tidak valid.
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.	Parameter TagKey yang ditentukan tidak valid.
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	Parameter TagKey yang ditentukan duplikat.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.