CreateVpnPbrRouteEntry - VPN Gateway - Alibaba Cloud Documentation Center

Membuat entri rute berbasis kebijakan VPN.

Deskripsi operasi

Sebelum memulai

Sebelum membuat entri rute berbasis kebijakan, pastikan Anda telah membuat koneksi IPsec-VPN. Untuk informasi selengkapnya, lihat CreateVpnConnection.
Sebelum membuat entri rute berbasis kebijakan, pahami batasan dan aturan pencocokan entri rute berbasis kebijakan. Untuk informasi selengkapnya, lihat Use policy-based routes.

Batasan

Untuk Gateway VPN saluran data tunggal:
- 0.0.0.0/0 tidak didukung sebagai Blok CIDR tujuan dari entri rute berbasis kebijakan.
- Blok CIDR yang tumpang tindih dengan 100.64.0.0/10 (termasuk 100.64.0.0/10 itu sendiri, subnetnya, dan Blok CIDR induknya) tidak didukung sebagai Blok CIDR tujuan dari entri rute berbasis kebijakan.
Operasi CreateVpnPbrRouteEntry bersifat asinkron. Sistem mengembalikan informasi entri rute berbasis kebijakan sebelum entri rute dibuat. Tugas pembuatan masih berjalan di latar belakang. Anda dapat memanggil operasi DescribeVpnGateway untuk mengkueri status Instans Gateway VPN dan memeriksa status pembuatan entri rute berbasis kebijakan:
- Jika Instans Gateway VPN berada dalam status updating, entri rute berbasis kebijakan sedang dibuat.
- Jika Instans Gateway VPN berada dalam status active, entri rute berbasis kebijakan telah dibuat.
Operasi CreateVpnPbrRouteEntry tidak mendukung pembuatan entri rute berbasis kebijakan secara bersamaan di bawah Instans Gateway VPN yang sama.

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:CreateVpnPbrRouteEntry

create

*VpnGateway.

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah Gateway VPN. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID wilayah.	cn-hangzhou
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan nilai ini, tetapi Anda harus memastikan nilainya unik di antara permintaan yang berbeda. Token klien hanya dapat berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan API sebagai ClientToken. RequestId dari setiap permintaan API bersifat unik.	d7d24a21-f4ba-4454-9173-b3****
VpnGatewayId	string	Yes	ID Gateway VPN.	vpn-bp1a3kqjiiq9legfx****
RouteSource	string	Yes	Blok CIDR sumber dari entri rute berbasis kebijakan.	192.168.1.0/24
RouteDest	string	Yes	Blok CIDR tujuan dari entri rute berbasis kebijakan.	10.0.0.0/24
NextHop	string	Yes	Lompatan berikutnya dari entri rute berbasis kebijakan.	vco-bp15oes1py4i66rmd****
Weight	integer	Yes	Bobot dari entri rute berbasis kebijakan. Saat Anda menggunakan Instans Gateway VPN yang sama untuk membuat koneksi IPsec-VPN aktif/siaga, Anda dapat menentukan tautan aktif/siaga dengan mengonfigurasi Bobot entri rute berbasis kebijakan. Entri rute berbasis kebijakan dengan Bobot 100 adalah tautan aktif secara default, dan entri rute berbasis kebijakan dengan Bobot 0 adalah tautan siaga secara default. Anda dapat mengonfigurasi pemeriksaan kesehatan untuk koneksi IPsec-VPN guna mendeteksi konektivitas tautan secara otomatis. Jika tautan aktif gagal, sistem secara otomatis mengalihkan Trafik ke tautan siaga untuk memastikan Ketersediaan tinggi tautan akses cloud. Untuk informasi selengkapnya, lihat CreateVpnConnection. Nilai valid: 100: Koneksi IPsec-VPN yang terkait entri rute berbasis kebijakan adalah tautan aktif. 0: Koneksi IPsec-VPN yang terkait entri rute berbasis kebijakan adalah tautan siaga. Catatan Saat Anda menentukan tautan aktif/siaga, Blok CIDR sumber dan tujuan dari entri rute berbasis kebijakan aktif/siaga harus sama. Untuk Instans Gateway VPN yang mendukung koneksi IPsec-VPN saluran data ganda, Anda tidak perlu mengonfigurasi parameter ini. Koneksi IPsec-VPN saluran data ganda berisi dua saluran data yang secara otomatis membentuk tautan aktif/siaga. Anda tidak perlu menentukan tautan aktif/siaga dengan mengonfigurasi parameter ini. Jika Anda mengonfigurasi parameter ini, pengaturan parameter tidak akan berlaku.	0
PublishVpc	boolean	Yes	Apakah akan memublikasikan entri rute berbasis kebijakan ke VPC. Nilai valid: true: Memublikasikan entri rute berbasis kebijakan ke VPC. Sistem hanya memublikasikan entri rute ke tabel rute sistem VPC, tetapi tidak ke tabel rute kustom. Jika Anda ingin tabel rute kustom VPC menyertakan entri rute ini, Anda harus menambahkannya secara manual. Untuk informasi selengkapnya, lihat CreateRouteEntry. false: Tidak memublikasikan entri rute berbasis kebijakan ke tabel rute VPC. Anda harus secara manual menambahkan entri rute berbasis kebijakan yang lompatan berikutnya mengarah ke Gateway VPN di tabel rute sistem dan tabel rute kustom VPC. Jika tidak, VPC tidak dapat mengakses Sumber daya di Blok CIDR melalui koneksi IPsec-VPN.	true
Description	string	No	Deskripsi dari entri rute berbasis kebijakan. Deskripsi harus memiliki panjang 1 hingga 100 karakter.	desctest
OverlayMode	string	No	Protokol saluran data. Atur nilainya menjadi Ipsec (protokol Terowongan IPsec).	Ipsec
Priority	integer	No	Prioritas kebijakan dari entri rute berbasis kebijakan. Nilai valid: 1 hingga 100. Nilai default: 10. Nilai yang lebih kecil menunjukkan Prioritas kebijakan yang lebih tinggi.	10
DryRun	boolean	No	Apakah akan hanya melakukan Pemeriksaan Awal pada permintaan. Nilai valid: true: Melakukan Pemeriksaan Awal pada permintaan tanpa membuat entri rute. Sistem memeriksa apakah parameter yang diperlukan telah ditentukan, format permintaan, dan batasan layanan. Jika permintaan gagal dalam Pemeriksaan Awal, kode kesalahan yang sesuai akan dikembalikan. Jika permintaan lulus Pemeriksaan Awal, kode kesalahan `DryRunOperation` akan dikembalikan. false (default): Mengirim permintaan. Jika permintaan lulus Pemeriksaan Awal, kode status HTTP 2xx akan dikembalikan dan operasi akan dijalankan.	false

Elemen respons

Element	Type	Description	Example
	object	Tanggapan.
NextHop	string	Lompatan berikutnya dari entri rute berbasis kebijakan.	vco-bp15oes1py4i66rmd****
Weight	integer	Bobot dari rute berbasis kebijakan. 100: Koneksi IPsec-VPN yang terkait entri rute berbasis kebijakan adalah tautan aktif. 0: Koneksi IPsec-VPN yang terkait entri rute berbasis kebijakan adalah tautan siaga.	0
RouteDest	string	Blok CIDR tujuan dari entri rute berbasis kebijakan.	10.0.0.0/24
RequestId	string	ID permintaan.	5BE01CD7-5A50-472D-AC14-CA181C5C03BE
Description	string	Deskripsi dari entri rute berbasis kebijakan.	desctest
State	string	Status publikasi dari entri rute berbasis kebijakan. published: Entri rute berbasis kebijakan telah dipublikasikan ke tabel rute VPC. normal: Entri rute berbasis kebijakan tidak dipublikasikan ke tabel rute VPC.	normal
CreateTime	integer	Stempel waktu saat entri rute berbasis kebijakan dibuat. Unit: milidetik. Stempel waktu mengikuti format waktu UNIX. Ini adalah jumlah total milidetik yang telah berlalu sejak 00:00:00 Kamis, 1 Januari 1970 (UTC).	1492747187000
OverlayMode	string	Protokol saluran data. Atur nilainya menjadi Ipsec (protokol Terowongan IPsec).	Ipsec
RouteSource	string	Blok CIDR sumber dari entri rute berbasis kebijakan.	192.168.1.0/24
VpnInstanceId	string	ID Gateway VPN.	vpn-bp1cmw7jh1nfe43m9****
Priority	integer	Prioritas kebijakan dari entri rute berbasis kebijakan.	10

Contoh

Respons sukses

JSONformat

{
  "NextHop": "vco-bp15oes1py4i66rmd****",
  "Weight": 0,
  "RouteDest": "10.0.0.0/24",
  "RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
  "Description": "desctest",
  "State": "normal",
  "CreateTime": 1492747187000,
  "OverlayMode": "Ipsec",
  "RouteSource": "192.168.1.0/24",
  "VpnInstanceId": "vpn-bp1cmw7jh1nfe43m9****",
  "Priority": 10
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Resource.QuotaFull	The quota of resource is full
400	VpnGateway.FinancialLocked	The specified service is financial locked.
400	VpnRouteEntry.AlreadyExists	The specified route entry is already exist.	Entri rute sudah ada.
400	VpnRouteEntry.Conflict	The specified route entry has conflict.	Terdapat konflik entri rute.
400	VpnRouteEntry.ConflictSSL	The specified route entry has conflict with SSL client.	Entri rute bertentangan dengan Klien SSL.
400	VpnRouteEntry.BackupRoute	Validate backup route entry failed.	Validasi entri rute aktif/standby gagal. Konfigurasi perutean tidak valid.
400	VpnRouteEntry.InvalidWeight	Invalid route entry weight value.	Nilai bobot entri rute tidak valid.
400	InvalidNextHop.NotFound	The specified NextHop does not exist.	Lompatan berikutnya yang ditentukan tidak ada.
400	IllegalParam.RouteDest	The specified RouteDest is invalid	Alamat tujuan tidak valid.
400	OperationFailed.RouteConflict	Operation failed because there is already a route in VPC route table to another VPN on the same network block.	Blok CIDR dalam daftar awalan yang ditentukan berkonflik dengan entri rute yang ada pada koneksi IPsec-VPN. Selesaikan konflik tersebut dan coba lagi.
400	OperationFailed.InvalidCidrBlock	Operation failed because the specified network block is invalid.	Blok CIDR tidak valid.
400	QuotaExceeded.VpnRouteEntry	The number of route entries to the VPN gateway in the VPC routing table has reached the quota limit.	Jumlah entri rute yang mengarah ke Gateway VPN di tabel rute VPC telah mencapai batas kuota.
400	VpnPbrRouteEntryPriority.NotSupport	Current version of the VPN does not support setting custom pbr route entry priority.	Versi Gateway VPN saat ini tidak mendukung fitur Prioritas rute.
400	TaskConflict	The operation is too frequent, please wait a moment and try again.	Operasi EIP terlalu sering.
400	VpnTask.CONFLICT	Vpn task has conflict.	Terjadi konflik operasi VPN. Coba lagi nanti.
400	VpnGateway.Configuring	The specified service is configuring.
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
400	VpnRouteEntry.SrcDestWeightConflict	The VPN gateway does not support Policy-based routing with the same source CIDR, destination CIDR and weight.	Gateway VPN tidak mendukung entri rute berbasis kebijakan yang memiliki blok CIDR sumber, blok CIDR tujuan, dan bobot yang sama.
400	VpnRouteEntry.SamePriorityPbrRoutePrefixOverlap	The source CIDR and destination CIDR of Policy-based routes with the same priority cannot overlap.	Gateway VPN tidak mendukung beberapa entri rute berbasis kebijakan pada prioritas yang sama yang memiliki blok CIDR sumber dan tujuan yang tumpang tindih secara bersamaan.
400	VpnRouteEntry.SrcDestConflict	The VPN gateway does not support Policy-based routing with the same source CIDR and destination CIDR.	Gateway VPN tipe dual-saluran data tidak mendukung entri rute berbasis kebijakan yang memiliki blok CIDR sumber dan blok CIDR tujuan yang sama.
400	CreatePbrRoutesQuotaFull.QuotaFull	The number of policy routes exceeds the quota limit.	Jumlah entri rute berbasis kebijakan melebihi batas kuota.
400	InvalidCidrBlock.Malformed	Specified CIDR block is not valid.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	Pemeriksaan DryRun berhasil.
400	VpnPbrRouteEntry.NotSupport	Current version of the VPN does not support pbr route entry.	Instans VPN saat ini tidak mendukung perutean berbasis kebijakan.
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.	Anda tidak memiliki izin untuk melakukan operasi pada sumber daya yang ditentukan. Ajukan izin yang diperlukan dan coba lagi.
404	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.