CreateCustomerGateway - VPN Gateway - Alibaba Cloud Documentation Center

Membuat gateway pelanggan.

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

create

*CustomerGateway.

acs:vpc:{#regionId}:{#accountId}:customergateway/*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah dari gateway pelanggan. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID wilayah.	cn-shanghai
ClientToken	string	No	Token client yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan client untuk menghasilkan token, tetapi Anda harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda. Token hanya boleh berisi karakter ASCII dan tidak boleh melebihi 64 karakter. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan API sebagai ClientToken. RequestId mungkin berbeda untuk setiap permintaan API.	02fb3da4-130e-11e9-8e44****
IpAddress	string	Yes	Alamat IP statis dari perangkat gateway di pusat data lokal. Jika Anda ingin membuat koneksi IPsec-VPN yang menggunakan jenis jaringan publik, masukkan alamat IP publik. Jika Anda ingin membuat koneksi IPsec-VPN yang menggunakan jenis jaringan pribadi, masukkan alamat IP pribadi. Alamat IP berikut tidak didukung. Jika Anda menggunakan alamat IP ini, koneksi IPsec-VPN tidak dapat dibuat: 100.64.0.0 hingga 100.127.255.255 127.0.0.0 hingga 127.255.255.255 169.254.0.0 hingga 169.254.255.255 224.0.0.0 hingga 239.255.255.255 255.0.0.0 hingga 255.255.255.255	101.12.XX.XX
Name	string	No	Nama gateway pelanggan. Nama harus terdiri dari 1 hingga 100 karakter dan tidak boleh dimulai dengan `http://` atau `https://`.	nametest
Description	string	No	Deskripsi gateway pelanggan. Deskripsi harus terdiri dari 1 hingga 100 karakter dan tidak boleh dimulai dengan `http://` atau `https://`.	desctest
Asn	string	No	Nomor Sistem Otonom (Autonomous System Number/ASN) dari perangkat gateway di pusat data lokal. Parameter ini wajib ditentukan jika Anda berencana mengaktifkan perutean dinamis Border Gateway Protocol (BGP) untuk koneksi IPsec-VPN. Nilai yang valid: 1 hingga 4294967295. Nilai 45104 tidak didukung. Asn adalah angka 4-byte yang dapat dimasukkan dalam format dua segmen: 16 bit pertama.16 bit terakhir. Setiap segmen dimasukkan dalam notasi desimal. Sebagai contoh, jika Anda memasukkan 123.456, ASN-nya adalah 123 × 65536 + 456 = 8061384. Catatan Gunakan ASN pribadi untuk membuat koneksi BGP dengan Alibaba Cloud. Untuk informasi lebih lanjut tentang rentang ASN pribadi, lihat dokumentasi terkait. 45104 adalah identitas unik yang dialokasikan kepada Alibaba Cloud Computing Co., Ltd. oleh Internet Assigned Numbers Authority (IANA). Identitas ini digunakan untuk mengidentifikasi Alibaba Cloud dalam perutean Internet global dan transmisi data.	65530
AuthKey	string	No	Kunci otentikasi protokol perutean BGP untuk perangkat gateway di pusat data lokal. Kunci harus terdiri dari 1 hingga 64 karakter dan hanya boleh berisi karakter ASCII. Spasi, karakter Tionghoa, dan tanda tanya half-width (?) tidak didukung.	AuthKey****
Tags	array<object>	No	Daftar tag yang akan ditambahkan ke gateway pelanggan. Anda dapat menambahkan hingga 20 tag ke gateway pelanggan sekaligus.
	object	No	Informasi tag.
Key	string	No	Kunci tag. Jika Anda menentukan parameter ini, nilainya tidak boleh berupa string kosong. Kunci tag dapat memiliki panjang maksimum 64 karakter dan tidak boleh dimulai dengan `aliyun` atau `acs:`. Kunci tag juga tidak boleh berisi `http://` atau `https://`. Anda dapat menentukan hingga 20 kunci tag sekaligus.	TagKey
Value	string	No	Nilai tag. Nilai tag dapat memiliki panjang maksimum 128 karakter dan boleh berupa string kosong. Nilai tag tidak boleh dimulai dengan `aliyun` atau `acs:` dan tidak boleh berisi `http://` atau `https://`. Setiap kunci tag sesuai dengan satu nilai tag. Anda dapat menentukan hingga 20 nilai tag sekaligus.	TagValue
ResourceGroupId	string	No	ID kelompok sumber daya tempat gateway pelanggan berada. Anda dapat memanggil operasi ListResourceGroups untuk mengkueri ID kelompok sumber daya. Jika Anda tidak menentukan kelompok sumber daya, gateway pelanggan akan ditambahkan ke kelompok sumber daya default setelah dibuat.	rg-aek2qo2h4jy****

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
RequestId	string	ID permintaan.	D32B3C26-6C6C-4988-93E9-D2A6444CE6AE
IpAddress	string	Alamat IP statis dari perangkat gateway di pusat data lokal.	101.12.XX.XX
Description	string	Deskripsi gateway pelanggan.	desctest
CustomerGatewayId	string	ID instans dari instans gateway pelanggan.	cgw-bp1jrawp82av6bws9****
CreateTime	integer	Timestamp saat gateway pelanggan dibuat. Satuan: milidetik. Timestamp dalam format UNIX dan merepresentasikan jumlah milidetik yang telah berlalu sejak 1 Januari 1970 pukul 00:00:00 UTC.	1493363486000
Name	string	Nama gateway pelanggan.	nametest

Contoh

Respons sukses

JSONformat

{
  "RequestId": "D32B3C26-6C6C-4988-93E9-D2A6444CE6AE",
  "IpAddress": "101.12.XX.XX",
  "Description": "desctest",
  "CustomerGatewayId": "cgw-bp1jrawp82av6bws9****",
  "CreateTime": 1493363486000,
  "Name": "nametest"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidAuthkey.Malformed	The specified BGP authentication key (%s) is malformed.	Kunci otentikasi BGP tidak valid.
400	InvalidIpAddress.AlreadyExist	Specified IpAddress is already exist.	Alamat IP sudah ada. Pengguna yang sama tidak dapat menggunakan alamat IP duplikat di wilayah yang sama.
400	InvalidIpAddress.WrongFormat	Specified IpAddress is invalid.
400	InvalidName	The name is not valid
400	InvalidDescription	The description is not valid
400	Resource.QuotaFull	The quota of resource is full
400	IllegalParam.Asn	The specified Asn is invalid.	ASN yang ditentukan tidak sesuai dengan spesifikasi.
400	OperationDenied.MissingAsn	The autonomous system number of the customer gateway is mandatory when BGP authentication key is specified.	Saat kunci otentikasi BGP dari gerbang pelanggan ditentukan, nomor sistem otonom juga harus ditentukan.
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	Parameter TagValue yang ditentukan tidak valid.
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	Jumlah tag melebihi batas.
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	Sumber daya tag duplikat.
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.
400	OperationFailed.NoRamPermission	Vpn Service has no permission to operate your IDaaS instances.	Layanan VPN tidak memiliki izin untuk beroperasi pada instans IDaaS Anda.
400	CreateVpnUserGatewayQuotaFull.QuotaFull	The number of created VPN customer gateways exceeds the quota.	Jumlah gerbang pelanggan VPN melebihi batas kuota.
403	Forbidden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	Anda tidak memiliki izin untuk beroperasi pada Sumber daya ini. Ajukan izin yang diperlukan dan coba lagi.
403	Forbidden	User not authorized to operate on the specified resource.	EIP bukan milik pemanggil saat ini. Periksa apakah Anda memiliki izin untuk mengakses EIP ini.
409	OperationConflict	The operation against this instance is too frequent, please try again later.	Terjadi konflik permintaan. Coba lagi nanti.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.