Memanggil operasi CreateCustomerGateway untuk membuat customer gateway.
Coba sekarang
Test
RAM authorization
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
ID region tempat customer gateway berada. Anda dapat memanggil operasi DescribeRegions untuk menanyakan ID region. |
cn-shanghai |
| ClientToken |
string |
No |
Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan nilai ini, tetapi Anda harus memastikan nilai tersebut unik di antara permintaan yang berbeda. Token hanya dapat 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 berbeda untuk setiap permintaan API. |
02fb3da4-130e-11e9-8e44**** |
| IpAddress |
string |
Yes |
Alamat IP statis dari perangkat gateway di pusat data on-premises.
Alamat IP berikut tidak didukung. Jika tidak, koneksi IPsec-VPN tidak dapat dibuat:
|
101.12.XX.XX |
| Name |
string |
No |
Nama customer gateway. Nama harus terdiri dari 1 hingga 100 karakter dan tidak boleh dimulai dengan |
nametest |
| Description |
string |
No |
Deskripsi customer gateway. Deskripsi harus terdiri dari 1 hingga 100 karakter dan tidak boleh dimulai dengan |
desctest |
| Asn |
string |
No |
Jika Anda ingin menggunakan protokol perutean dinamis Border Gateway Protocol (BGP) untuk koneksi IPsec-VPN, Anda harus mengonfigurasi nomor sistem otonom (ASN) untuk perangkat gateway di pusat data on-premises. Rentang nilai ASN adalah 1 hingga 4294967295. Nilai 45104 tidak didukung. Asn adalah angka 4-byte. Anda dapat memasukkan nilai dalam format dua segmen, yaitu 16 bit pertama.16 bit terakhir. Setiap segmen harus dimasukkan dalam format desimal. Misalnya, jika Anda memasukkan 123.456, ASN dihitung sebagai: 123*65536+456=8061384. Catatan
|
65530 |
| AuthKey |
string |
No |
Kunci autentikasi protokol perutean BGP dari perangkat gateway di pusat data on-premises. Kunci harus terdiri dari 1 hingga 64 karakter dan hanya dapat berisi karakter ASCII. Spasi, karakter Mandarin, dan tanda tanya (?) tidak diizinkan. |
AuthKey**** |
| Tags |
array<object> |
No |
Daftar tag yang akan ditambahkan ke customer gateway. Anda dapat menambahkan hingga 20 tag ke customer gateway dalam satu waktu. |
|
|
object |
No |
Informasi tag. |
||
| Key |
string |
No |
Kunci tag. Setelah nilai dimasukkan, nilai tersebut tidak boleh berupa string kosong. Kunci harus memiliki panjang hingga 64 karakter dan tidak boleh dimulai dengan Anda dapat menentukan hingga 20 kunci tag dalam satu waktu. |
TagKey |
| Value |
string |
No |
Nilai tag. Nilai tag harus memiliki panjang hingga 128 karakter dan dapat berupa string kosong. Nilai tag tidak boleh dimulai dengan Setiap kunci tag berkorespondensi dengan satu nilai tag. Anda dapat menentukan hingga 20 nilai tag dalam satu waktu. |
TagValue |
| ResourceGroupId |
string |
No |
ID dari grup sumber daya tempat customer gateway berada.
|
rg-aek2qo2h4jy**** |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Hasil yang dikembalikan. |
||
| RequestId |
string |
ID permintaan. |
D32B3C26-6C6C-4988-93E9-D2A6444CE6AE |
| IpAddress |
string |
Alamat IP statis dari perangkat gateway di pusat data on-premises. |
101.12.XX.XX |
| Description |
string |
Deskripsi customer gateway. |
desctest |
| CustomerGatewayId |
string |
ID instans dari customer gateway. |
cgw-bp1jrawp82av6bws9**** |
| CreateTime |
integer |
Stempel waktu saat customer gateway dibuat. Satuan: milidetik. Nilai ini adalah stempel waktu UNIX yang mewakili jumlah milidetik yang telah berlalu sejak 00:00:00 Kamis, 1 Januari 1970 (GMT). |
1493363486000 |
| Name |
string |
Nama customer gateway. |
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. | |
| 400 | InvalidIpAddress.AlreadyExist | Specified IpAddress is already exist. | |
| 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. | |
| 400 | OperationDenied.MissingAsn | The autonomous system number of the customer gateway is mandatory when BGP authentication key is specified. | |
| 400 | InvalidParameter.TagValue | The specified parameter TagValue is invalid. | |
| 400 | SizeLimitExceeded.TagNum | The maximum number of tags is exceeded. | |
| 400 | Forbidden.TagKey.Duplicated | The specified tag key already exists. | |
| 400 | InvalidParameter.TagKey | The specified parameter TagKey is invalid. | |
| 400 | Duplicated.TagKey | The specified parameter TagKey is duplicated. | |
| 400 | OperationFailed.NoRamPermission | Vpn Service has no permission to operate your IDaaS instances. | |
| 400 | CreateVpnUserGatewayQuotaFull.QuotaFull | The number of created VPN customer gateways exceeds the quota. | |
| 403 | Forbidden.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. | |
| 409 | OperationConflict | The operation against this instance is too frequent, please try again later. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.