All Products
Search

This Product

    VPN Gateway:ModifyVpnGatewayAttribute

    Document Center

    VPN Gateway:ModifyVpnGatewayAttribute

    Last Updated:Oct 10, 2026

    Mengubah nama, deskripsi, atau fitur propagasi entri rute otomatis dari Gateway VPN.

    Deskripsi operasi

    • Operasi ModifyVpnGatewayAttribute bersifat asinkron. Sistem mengembalikan informasi Gateway VPN sebelum konfigurasi diubah. Tugas modifikasi masih berjalan di latar belakang. Anda dapat memanggil operasi 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.

    • Operasi 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

    Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

    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 menghasilkan nilai parameter di klien Anda untuk memastikan nilai tersebut unik di antara permintaan yang berbeda. Token klien hanya mendukung karakter ASCII.

    Catatan

    Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan API sebagai token klien. RequestId setiap permintaan API berbeda.

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

    string

    Yes

    ID Gateway VPN.

    vpn-bp1q8bgx4xnkm2ogj****
    Name

    string

    No

    Nama baru Gateway VPN.

    Panjang nama harus 2 hingga 100 karakter. Tidak dapat dimulai dengan http:// atau https://. Harus dimulai dengan huruf dan dapat berisi huruf, 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 fitur propagasi entri rute otomatis untuk Gateway VPN. Nilai valid:

    • true: Mengaktifkan fitur.

      Setelah propagasi entri rute otomatis diaktifkan, Instans Gateway VPN secara otomatis mempelajari entri rute sistem dalam tabel rute sistem VPC dan secara otomatis mempropagasikan entri rute pusat data lokal ke tabel rute sistem VPC.

    • false: Menonaktifkan fitur.

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

    true

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Tanggapan.

    VpcId

    string

    ID VPC tempat Gateway VPN berada.

    vpc-bp1ub1yt9cvakoel****
    Status

    string

    Status Gateway VPN. Nilai valid:

    • init: menginisialisasi

    • provisioning: menyiapkan

    • active: aktif

    • updating: memperbarui

    • deleting: menghapus

    active
    InternetIp

    string

    • Jika Gateway VPN mendukung koneksi IPsec-VPN saluran data tunggal, parameter ini menunjukkan alamat IP Gateway VPN, yang dapat digunakan untuk membuat koneksi IPsec-VPN atau koneksi SSL-VPN.

    • Jika Gateway VPN mendukung koneksi IPsec-VPN saluran data ganda, parameter ini menunjukkan alamat IP pertama yang digunakan untuk membuat koneksi IPsec-VPN. Parameter ini tidak dapat digunakan untuk membuat koneksi SSL-VPN.

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

    116.62.XX.XX
    Spec

    string

    Spesifikasi bandwidth Gateway VPN. Unit: Mbit/s.

    5M
    CreateTime

    integer

    Stempel waktu UNIX saat Gateway VPN dibuat. Unit: milidetik.

    Stempel waktu UNIX mengikuti format waktu UNIX. Stempel waktu menunjukkan jumlah total milidetik yang telah berlalu sejak waktu epoch 1 Januari 1970, 00:00:00 UTC.

    1492753580000
    AutoPropagate

    boolean

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

    • true: secara otomatis dipropagasikan

    • false: tidak secara otomatis dipropagasikan

    true
    VpnGatewayId

    string

    ID Gateway VPN.

    vpn-bp1q8bgx4xnkm2ogj****
    IntranetIp

    string

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

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

    172.16.10.46
    EndTime

    integer

    Stempel waktu UNIX saat Instans Gateway VPN kedaluwarsa. Unit: milidetik.

    Stempel waktu UNIX mengikuti format waktu UNIX. Stempel waktu menunjukkan jumlah total milidetik yang telah berlalu sejak waktu epoch 1 Januari 1970, 00:00:00 UTC hingga Instans Gateway VPN kedaluwarsa.

    1495382400000
    VSwitchId

    string

    ID vSwitch yang terkait dengan Gateway VPN.

    vsw-bp1y9ovl1cu9ou4tv****
    RequestId

    string

    ID permintaan.

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

    string

    Deskripsi Gateway VPN.

    test
    EnableBgp

    boolean

    Apakah fitur BGP diaktifkan untuk Gateway VPN. Nilai valid:

    • true: diaktifkan

    • false: dinonaktifkan

    true
    BusinessStatus

    string

    Status penagihan Instans Gateway VPN. Nilai valid:

    • Normal: normal

    • FinancialLocked: terkunci karena pembayaran tertunda

    Normal
    Name

    string

    Nama Gateway VPN.

    test
    DisasterRecoveryInternetIp

    string

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

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

    116.11.XX.XX
    DisasterRecoveryVSwitchId

    string

    ID vSwitch kedua yang terkait dengan Gateway VPN.

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

    vsw-p0w95ql6tmr2ludkt****
    SslVpnInternetIp

    string

    Alamat IP koneksi SSL-VPN.

    Parameter ini hanya dikembalikan setelah fitur SSL-VPN diaktifkan untuk Instans Gateway VPN jenis jaringan publik yang mendukung koneksi IPsec-VPN saluran data ganda.

    116.33.XX.XX
    ResourceGroupId

    string

    ID kelompok sumber daya tempat Gateway VPN berada.

    Anda dapat memanggil operasi 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 Gateway VPN saat ini tidak mendukung BGP.
    400 OperationFailed.VpnConnectionExist Auto propagate cannot be closed when VPN connections with BGP enabled exist. Propagasi rute otomatis tidak dapat dinonaktifkan ketika terdapat koneksi VPN dengan BGP yang diaktifkan.
    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. BGP tidak dapat diaktifkan untuk Gateway VPN karena VPC tempat Gateway VPN berada telah bergabung dengan instans Cloud Enterprise Network dengan Sinkronisasi rute diaktifkan.
    400 OperationFailed.VpcRoutePropagationDisable The VPC system routing table does not enable the acceptance of propagated routes. Tabel rute sistem VPC tidak mengaktifkan penerimaan propagasi rute.
    400 OperationFailed.VpcRoutePublishEnabledInTR A VPC supports at most one dynamic route learning source. In the forwarding router, disable route synchronization for the VPC. VPC hanya mendukung satu sumber pembelajaran entri rute dinamis. Nonaktifkan Sinkronisasi rute untuk VPC di router transit.
    400 OperationFailed.VpcRoutePublishEnabledInECR VPC supports only one dynamic route learning source at most. Please remove the VPC from ECR. VPC hanya mendukung satu sumber pembelajaran entri rute dinamis. Hapus VPC dari Express Connect Router (ECR).
    400 OperationFailed.BondingVpnNotSupportBGP The architecture does not support BGP capabilities (single tunnel bonding architecture VPN gateway). Arsitektur tidak mendukung kemampuan BGP (arsitektur penggabungan saluran data tunggal Gateway VPN).
    400 OperationFailed.StaleBGPRoutes BGP routes are still there and automatic route propagation cannot be disabled. Terdapat entri rute BGP sisa. Propagasi entri 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 melakukan operasi pada Sumber daya ini. Ajukan izin yang diperlukan dan coba lagi.
    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.