All Products
Search

This Product

    VPN Gateway:ModifyVpnGatewayAttribute

    Document Center

    VPN Gateway:ModifyVpnGatewayAttribute

    Last Updated:Jun 19, 2026

    Memanggil operasi ModifyVpnGatewayAttribute untuk mengubah nama, deskripsi, atau fitur propagasi otomatis Gateway VPN.

    Deskripsi operasi

    • ModifyVpnGatewayAttribute adalah operasi asinkron. Setelah Anda memanggil operasi ini, sistem mengembalikan informasi Gateway VPN, tetapi konfigurasi belum diubah. Tugas modifikasi masih berjalan di latar belakang. Anda dapat memanggil DescribeVpnGateway untuk mengkueri status modifikasi konfigurasi Gateway VPN:

      • Jika Gateway VPN berada dalam status updating, konfigurasi sedang dimodifikasi.

      • Jika Gateway VPN berada dalam status active, konfigurasi telah dimodifikasi.

    • ModifyVpnGatewayAttribute tidak mendukung modifikasi konkuren pada konfigurasi 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:ModifyVpnGatewayAttribute

    update

    *VpnGateway

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    ID wilayah instans Gateway VPN. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru.

    cn-hangzhou
    ClientToken

    string

    No

    Token klien yang digunakan untuk memastikan idempotensi permintaan.

    Anda dapat menggunakan klien untuk menghasilkan token, tetapi Anda harus memastikan bahwa token tersebut 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 mungkin berbeda untuk setiap permintaan API.

    123e4567-e89b-12d3-a456-4266****
    VpnGatewayId

    string

    Yes

    ID instans Gateway VPN.

    vpn-bp1q8bgx4xnkm2ogj****
    Name

    string

    No

    Nama baru Gateway VPN.

    Panjang nama harus 2 hingga 100 karakter dan tidak dapat dimulai dengan http:// atau https://. Nama harus dimulai dengan huruf besar atau kecil dan dapat berisi huruf besar dan kecil, digit, garis bawah (_), tanda hubung (-), dan titik (.). Karakter khusus lainnya tidak didukung.

    myvpn
    Description

    string

    No

    Deskripsi baru Gateway VPN.

    Panjang deskripsi harus 1 hingga 100 karakter.

    test
    AutoPropagate

    boolean

    No

    Apakah akan mengaktifkan propagasi otomatis untuk Gateway VPN. Nilai valid:

    • true: Diaktifkan.

      Setelah propagasi otomatis diaktifkan, instans Gateway VPN secara otomatis mempelajari entri rute sistem dari tabel rute sistem instans yang terhubung ke VPC dan secara otomatis mempropagasi entri rute pusat data lokal ke tabel rute sistem instans yang terhubung ke VPC.

    • false: Dinonaktifkan.

      Sebelum Anda menonaktifkan propagasi otomatis, pastikan bahwa fitur Rute dinamis BGP dinonaktifkan untuk semua koneksi IPsec-VPN di bawah Gateway VPN.

    true

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter tanggapan.

    VpcId

    string

    ID VPC tempat instans Gateway VPN berada.

    vpc-bp1ub1yt9cvakoel****
    Status

    string

    Status Gateway VPN. Nilai valid:

    • init: Menginisialisasi.

    • provisioning: Mempersiapkan.

    • active: Normal.

    • updating: Memperbarui.

    • deleting: Menghapus.

    active
    InternetIp

    string

    • Jika instans Gateway VPN mendukung pembuatan koneksi IPsec-VPN saluran data tunggal, alamat ini adalah alamat IP instans Gateway VPN dan dapat digunakan untuk membuat koneksi IPsec-VPN atau koneksi SSL-VPN.

    • Jika instans Gateway VPN mendukung pembuatan koneksi IPsec-VPN saluran data ganda, alamat ini adalah alamat IP pertama yang digunakan untuk membuat koneksi IPsec-VPN dan tidak dapat digunakan untuk membuat koneksi SSL-VPN.

      Jika instans Gateway VPN mendukung pembuatan koneksi IPsec-VPN saluran data ganda, sistem menetapkan dua alamat IP IPsec ke instans Gateway VPN untuk membuat koneksi IPsec-VPN saluran data ganda.

    116.62.XX.XX
    Spec

    string

    Spesifikasi bandwidth instans Gateway VPN. Unit: Mbit/s.

    5M
    CreateTime

    integer

    Pengatur waktu saat instans Gateway VPN dibuat. Unit: milidetik.

    Pengatur waktu mengikuti format UNIX, yang merepresentasikan jumlah total milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC.

    1492753580000
    AutoPropagate

    boolean

    Apakah entri rute BGP secara otomatis dipropagasi ke VPC. Nilai valid:

    • true: Propagasi otomatis diaktifkan.

    • false: Propagasi otomatis tidak diaktifkan.

    true
    VpnGatewayId

    string

    ID instans Gateway VPN.

    vpn-bp1q8bgx4xnkm2ogj****
    IntranetIp

    string

    Alamat IP pribadi vSwitch yang ditempati oleh sistem saat menerapkan instans Gateway VPN.

    Parameter ini hanya dikembalikan untuk instans Gateway VPN yang hanya mendukung koneksi IPsec-VPN saluran data tunggal dan memiliki fitur IPsec-VPN yang diaktifkan.

    172.16.10.46
    EndTime

    integer

    Pengatur waktu saat instans Gateway VPN kedaluwarsa. Unit: milidetik.

    Pengatur waktu mengikuti format UNIX, yang merepresentasikan jumlah total milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC.

    1495382400000
    VSwitchId

    string

    ID vSwitch yang terkait dengan instans Gateway VPN.

    vsw-bp1y9ovl1cu9ou4tv****
    RequestId

    string

    ID permintaan.

    54B48E3D-DF70-471B-AA93-08E683A1B457
    Description

    string

    Deskripsi instans Gateway VPN.

    test
    EnableBgp

    boolean

    Status aktif fitur BGP untuk Gateway VPN. Nilai valid:

    • true: Diaktifkan.

    • false: Tidak diaktifkan.

    true
    BusinessStatus

    string

    Status penagihan instans Gateway VPN. Nilai valid:

    • Normal: Normal.

    • FinancialLocked: Terkunci karena Pembayaran tertunda.

    Normal
    Name

    string

    Nama instans Gateway VPN.

    test
    DisasterRecoveryInternetIp

    string

    Alamat IP kedua yang ditetapkan oleh sistem ke instans Gateway VPN untuk membuat koneksi IPsec-VPN.

    Parameter ini hanya dikembalikan untuk instans Gateway VPN yang mendukung pembuatan koneksi IPsec-VPN saluran data ganda.

    116.11.XX.XX
    DisasterRecoveryVSwitchId

    string

    ID vSwitch kedua yang terkait dengan instans Gateway VPN.

    Parameter ini hanya dikembalikan untuk instans Gateway VPN yang mendukung pembuatan koneksi IPsec-VPN saluran data ganda.

    vsw-p0w95ql6tmr2ludkt****
    SslVpnInternetIp

    string

    Alamat IP koneksi SSL-VPN.

    Parameter ini hanya dikembalikan ketika fitur SSL-VPN diaktifkan untuk instans Gateway VPN yang mendukung pembuatan koneksi IPsec-VPN saluran data ganda dan menggunakan jenis jaringan publik.

    116.33.XX.XX
    ResourceGroupId

    string

    ID kelompok sumber daya tempat instans Gateway VPN berada.

    Anda dapat memanggil ListResourceGroups untuk mengkueri informasi kelompok sumber daya.

    rg-acfmzs372yg****

    Contoh

    Respons sukses

    JSONformat

    {
  "VpcId": "vpc-bp1ub1yt9cvakoel****",
  "Status": "active",
  "InternetIp": "116.62.XX.XX",
  "Spec": "5M",
  "CreateTime": 1492753580000,
  "AutoPropagate": true,
  "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
  "IntranetIp": "172.16.10.46",
  "EndTime": 1495382400000,
  "VSwitchId": "vsw-bp1y9ovl1cu9ou4tv****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457",
  "Description": "test",
  "EnableBgp": true,
  "BusinessStatus": "Normal",
  "Name": "test",
  "DisasterRecoveryInternetIp": "116.11.XX.XX",
  "DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
  "SslVpnInternetIp": "116.33.XX.XX",
  "ResourceGroupId": "rg-acfmzs372yg****"
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidName The name is not valid
    400 InvalidDescription The description is not valid
    400 OperationUnsupported.EnableBgp Current version of the VPN does not support enable BGP. Versi VPN saat ini tidak mendukung pengaktifan BGP.
    400 OperationFailed.VpnConnectionExist Auto propagate cannot be closed when VPN connections with BGP enabled exist. Propagasi otomatis tidak dapat dinonaktifkan ketika koneksi VPN dengan BGP yang diaktifkan masih ada.
    400 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist. Gateway VPN yang ditentukan tidak ada. Periksa apakah gateway VPN sudah benar.
    400 VpnGateway.Configuring The specified service is configuring.
    400 OperationFailed.CenLevelNotSupport When the VPC to which the VPN gateway belongs is attached to a FULL-mode CEN, the VPN gateway cannot enable BGP. Ketika VPC tempat gateway VPN berada terhubung ke CEN dengan sinkronisasi rute yang diaktifkan, BGP tidak dapat diaktifkan untuk gateway VPN.
    400 OperationFailed.VpcRoutePropagationDisable The VPC system routing table does not enable the acceptance of propagated routes. Tabel perutean sistem VPC tidak memiliki penerimaan rute yang disebarkan yang diaktifkan.
    400 OperationFailed.VpcRoutePublishEnabledInTR A VPC supports at most one dynamic route learning source. In the forwarding router, disable route synchronization for the VPC. Sebuah VPC paling banyak mendukung satu sumber pembelajaran rute dinamis. Nonaktifkan sinkronisasi rute untuk VPC di transit router.
    400 OperationFailed.VpcRoutePublishEnabledInECR VPC supports only one dynamic route learning source at most. Please remove the VPC from ECR. Sebuah VPC paling banyak mendukung satu sumber pembelajaran rute dinamis. Hapus VPC dari ECR.
    400 OperationFailed.BondingVpnNotSupportBGP The architecture does not support BGP capabilities (single tunnel bonding architecture VPN gateway). Arsitektur tidak mendukung kemampuan BGP (gateway VPN arsitektur bonding tunnel tunggal).
    400 OperationFailed.StaleBGPRoutes BGP routes are still there and automatic route propagation cannot be disabled. Terdapat rute BGP yang tersisa. Propagasi rute otomatis tidak dapat dinonaktifkan.
    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 mengelola sumber daya ini. Ajukan permohonan izin dan coba lagi.
    403 Forbidden User not authorized to operate on the specified resource. Anda tidak memiliki izin untuk mengelola sumber daya yang ditentukan. Ajukan permohonan izin 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.