全部產品
Search
文件中心

VPN Gateway:ModifyVpnConnectionAttribute

更新時間:Oct 08, 2026

呼叫ModifyVpnConnectionAttribute介面修改IPsec連線的設定資訊。

介面說明

  • 如果要修改雙隧道模式的 IPsec-VPN 連線,呼叫ModifyVpnConnectionAttribute介面時除支援設定必填參數外,還支援設定以下請求參數:

    ClientToken、Name、 LocalSubnet、RemoteSubnet、EffectImmediately、AutoConfigRoute、TunnelOptionsSpecification 陣列、EnableTunnelsBgp。

  • 如果要修改單隧道模式的 IPsec-VPN 連線,呼叫ModifyVpnConnectionAttribute介面時除支援設定必填參數外,還支援設定以下請求參數:

    ClientToken、Name、LocalSubnet、RemoteSubnet、EffectImmediately、IkeConfig、IpsecConfig、HealthCheckConfig、AutoConfigRoute、EnableDpd、EnableNatTraversal、BgpConfig、RemoteCaCertificate。

  • ModifyVpnConnectionAttribute 介面屬於非同步介面,即系統回傳一個請求 ID,但該 IPsec 連線的設定資訊未修改成功,系統後台的修改任務仍在進行。您可以呼叫 DescribeVpnGateway 查詢 VPN 閘道器執行個體狀態,來確定 IPsec 連線的設定資訊的修改狀態:

    • 當 VPN 閘道器執行個體處於 updating 狀態時,表示 IPsec 連線的設定資訊正在修改中。

    • 當 VPN 閘道器執行個體處於 active 狀態時,表示 IPsec 連線的設定資訊修改成功。

  • ModifyVpnConnectionAttribute 介面不支援在同一 VPN 閘道器下並行修改 IPsec 連線的設定資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:ModifyVpnConnectionAttribute

update

*VpnConnection

acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}

無 無

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

是

IPsec 連線所在的區域 ID。

您可以透過呼叫 DescribeRegions 介面取得區域 ID。

cn-shanghai

ClientToken

string

否

用戶端 Token,用於保證請求的冪等性。

從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。

說明

若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 都不一樣。

02fb3da4-130e-11e9-8e44-0016e04115b

VpnConnectionId

string

是

IPsec 連線的 ID。

vco-bp1bbi27hojx80nck****

Name

string

否

IPsec 連線的名稱。

長度為 1~100 個字元,不能以http://或https://開頭。

nametest

LocalSubnet

string

否

需要和本地資料中心互連的 VPC 側的網段,用於第二階段協商。

多個網段之間用半形逗號(,)分隔,例如:192.168.1.0/24,192.168.2.0/24。

關於 IPsec 連線路由模式的說明:

  • 如果 LocalSubnet 和 RemoteSubnet 均輸入為 0.0.0.0/0,則表示您使用目的路由模式。

  • 如果 LocalSubnet 和 RemoteSubnet 均輸入具體的網段,則表示您使用感興趣流模式。

10.1.1.0/24,10.1.2.0/24

RemoteSubnet

string

否

本地資料中心側的網段,用於第二階段協商。

多個網段之間用半形逗號(,)分隔,例如:192.168.3.0/24,192.168.4.0/24。

關於 IPsec 連線路由模式的說明:

  • 如果 LocalSubnet 和 RemoteSubnet 均輸入為 0.0.0.0/0,則表示您使用目的路由模式。

  • 如果 LocalSubnet 和 RemoteSubnet 均輸入具體的網段,則表示您使用感興趣流模式。

10.2.1.0/24,10.2.2.0/24

EffectImmediately

boolean

否

選擇 IPsec 連線的設定是否立即生效。取值:

  • true:是,設定完成後系統立即進行 IPsec 協定協商。

  • false:否,當有流量進入時系統才進行 IPsec 協定協商。

false

IkeConfig

string

否

修改單隧道模式的 IPsec-VPN 連線時支援設定該參數。

第一階段協商的設定資訊:

  • IkeConfig.Psk:預共用金鑰,用於 VPN 閘道器與本地資料中心之間的身份驗證。

    • 金鑰長度為 1~100 個字元,支援數字、大小寫英文字母以及以下字元,不能包含空格。~!`@#$%^&*()_-+={}[]|;:',.<>/?

    • 若您未指定預共用金鑰,系統會隨機產生一個 16 位元的字串作為預共用金鑰。您可以呼叫 DescribeVpnConnection 介面查詢系統自動產生的預共用金鑰。

    說明

    IPsec 連線側的預共用金鑰需和本地資料中心側的驗證金鑰一致,否則本地資料中心和 VPN 閘道器之間無法建立連線。

  • IkeConfig.IkeVersion:IKE 協定的版本。取值:ikev1 或 ikev2。

    相對於 IKEv1 版本,IKEv2 版本簡化了 SA 的協商過程並且對於多網段的場景提供了更好的支援。

  • IkeConfig.IkeMode:IKE 版本的協商模式。取值:main 或 aggressive。

    • main:主模式,協商過程安全性高。

    • aggressive:野蠻模式,協商快速且協商成功率高。

  • IkeConfig.IkeEncAlg:第一階段協商的加密演算法。

    取值:aes、aes192、aes256、des 或 3des。

  • IkeConfig.IkeAuthAlg:第一階段協商的驗證演算法。

    取值:md5、sha1、sha256、sha384、sha512。

  • IkeConfig.IkePfs:第一階段協商使用的 Diffie-Hellman 金鑰交換演算法。取值:group1、group2、group5、group14。

  • IkeConfig.IkeLifetime:第一階段協商出的 SA 的生存週期。單位:秒。取值範圍:0~86400。

  • IkeConfig.LocalId:VPN 閘道器的標識。長度限制為 100 個字元,不能包含空格。預設值為 VPN 閘道器的 IP 位址。

  • IkeConfig.RemoteId:使用者閘道器的標識。長度限制為 100 個字元,不能包含空格。預設值為使用者閘道器的 IP 位址。

{"Psk":"pgw6dy7d1i8i****","IkeVersion":"ikev1","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400,"LocalId":"116.64.XX.XX","RemoteId":"139.18.XX.XX"}

IpsecConfig

string

否

修改單隧道模式的 IPsec-VPN 連線時支援設定該參數。

第二階段協商的設定資訊:

  • IpsecConfig.IpsecEncAlg:第二階段協商的加密演算法。

    取值:aes、aes192、aes256、des 或 3des。

  • IpsecConfig.IpsecAuthAlg:第二階段協商的驗證演算法。

    取值:md5、sha1、sha256、sha384、sha512。

  • IpsecConfig.IpsecPfs:轉送所有協定的封包,第一階段協商使用的 Diffie-Hellman 金鑰交換演算法。取值:disabled、group1、group2、group5、group14。

  • IpsecConfig.IpsecLifetime:第二階段協商出的 SA 的生存週期。單位:秒。取值範圍:0~86400。

{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}

HealthCheckConfig

string

否

修改單隧道模式的 IPsec-VPN 連線時支援設定該參數。

健康檢查設定資訊:

  • HealthCheckConfig.enable:是否開啟健康檢查。取值:true 或 false。

  • HealthCheckConfig.dip:健康檢查的目的 IP 位址。

  • HealthCheckConfig.sip:健康檢查的來源 IP 位址。

  • HealthCheckConfig.interval:健康檢查的重試間隔時間,單位:秒。

  • HealthCheckConfig.retry:健康檢查的重試發送封包次數。

{"enable":"true","dip":"192.168.1.1","sip":"10.1.1.1","interval":"3","retry":"3"}

AutoConfigRoute

boolean

否

是否自動發佈路由。取值:

  • true:自動發佈。

  • false:不自動發佈。

true

EnableDpd

boolean

否

修改單隧道模式的 IPsec-VPN 連線時支援設定該參數。

是否開啟 DPD(對等節點存活偵測)功能。取值:

  • true:開啟 DPD 功能。IPsec 發起端會傳送 DPD 封包用來偵測對端的裝置是否存活,如果在設定時間內未收到正確回應則認為對端已經斷線,IPsec 將刪除 ISAKMP SA 和相應的 IPsec SA,安全隧道同樣也會被刪除。

  • false:不開啟 DPD 功能,IPsec 發起端不會傳送 DPD 偵測封包。

true

EnableNatTraversal

boolean

否

修改單隧道模式的 IPsec-VPN 連線時支援設定該參數。

是否開啟 NAT 穿越功能。取值:

  • true:開啟 NAT 穿越功能。開啟後,IKE 協商過程會刪除對 UDP 連接埠號的驗證過程,同時實現對 VPN 隧道中 NAT 閘道器裝置的發現功能。

  • false:不開啟 NAT 穿越功能。

true

BgpConfig

string

否

修改單隧道模式的 IPsec-VPN 連線時支援設定該參數。

BGP 的設定資訊:

  • BgpConfig.EnableBgp:是否開啟 BGP 功能。取值:true 或 false。

  • BgpConfig.LocalAsn:阿里雲側的自治系統號。自治系統號取值範圍:1~4294967295。

    支援按照兩段式的格式進行輸入,即:前 16 位元.後 16 位元。每個區段使用十進位輸入。

    例如輸入 123.456,則表示自治系統號:123*65536+456=8061384。

  • BgpConfig.TunnelCidr:IPsec 隧道網段。該網段需是一個在 169.254.0.0/16 內的遮罩長度為 30 的網段,且不能是 169.254.0.0/30、169.254.1.0/30、169.254.2.0/30、169.254.3.0/30、169.254.4.0/30、169.254.5.0/30、169.254.6.0/30 和 169.254.169.252/30。

    說明

    一個 VPN 閘道器執行個體下每個 IPsec 連線的 IPsec 隧道網段需保持唯一。

  • LocalBgpIp:阿里雲側的 BGP 位址。該位址為 IPsec 隧道網段內的一個 IP 位址。

說明
  • 當您的 VPN 閘道器啟用 BGP 動態路由功能時需要設定該參數。

  • 在新增 BGP 設定前,建議您先瞭解 BGP 動態路由功能的運作機制和使用限制。更多資訊,請參閱設定 BGP 動態路由 。

  • 建議您使用自治系統號的私有號碼與阿里雲建立 BGP 連線。自治系統號的私有號碼範圍請自行查閱文件。

{"EnableBgp":"true","LocalAsn":"65530","TunnelCidr":"169.254.11.0/30","LocalBgpIp":"169.254.11.1"}

RemoteCaCertificate

string

否

修改單隧道模式的 IPsec-VPN 連線時支援設定該參數。

如果目前 VPN 閘道器執行個體為國密型 VPN 閘道器,您可以修改對端的 CA 憑證。

如果目前 VPN 閘道器執行個體為普通型 VPN 閘道器,不支援設定本參數。

-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----

TunnelOptionsSpecification

array<object>

否

修改隧道的設定。

僅修改雙隧道模式的 IPsec-VPN 連線時支援設定 TunnelOptionsSpecification 陣列下的參數。您可以同時修改 IPsec-VPN 連線主隧道和備隧道的設定。

array<object>

否

修改隧道設定。

TunnelId

string

否

隧道 ID。

tun-opsqc4d97wni27****

CustomerGatewayId

string

否

隧道關聯的使用者閘道器執行個體 ID。

cgw-1nmwbpgrp7ssqm1yn****

Role

string

否

隧道的角色。

  • master:表示目前隧道為主隧道。

  • slave:表示目前隧道為備隧道。

master

EnableDpd

boolean

否

是否為隧道開啟 DPD(對等節點存活偵測)功能。取值:

  • true:開啟 DPD 功能。IPsec 發起端會傳送 DPD 封包用來偵測對端的裝置是否存活,如果在設定時間內未收到正確回應則認為對端已經斷線,IPsec 將刪除 ISAKMP SA 和相應的 IPsec SA,安全隧道同樣也會被刪除。

  • false:不開啟 DPD 功能,IPsec 發起端不會傳送 DPD 偵測封包。

true

EnableNatTraversal

boolean

否

是否為隧道開啟 NAT 穿越功能。取值:

  • true:開啟 NAT 穿越功能。開啟後,IKE 協商過程會刪除對 UDP 連接埠號的驗證過程,同時實現對 VPN 隧道中 NAT 閘道器裝置的發現功能。

  • false:不開啟 NAT 穿越功能。

true

RemoteCaCertificate

string

否

如果目前 VPN 閘道器執行個體為國密型 VPN 閘道器,您可以隧道修改對端的 CA 憑證。

如果目前 VPN 閘道器執行個體為普通型 VPN 閘道器,不支援設定本參數。

-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----

TunnelBgpConfig

object

否

修改隧道的 BGP 設定。

LocalAsn

integer

否

隧道本端(阿里雲側)的自治系統號。自治系統號取值範圍:1~4294967295。預設值:45104。

說明
  • 當您為 IPsec 連線開啟 BGP 功能後(即指定 EnableTunnelsBgp 參數的值為 true)支援設定或修改本參數。

  • 在新增 BGP 設定前,建議您先瞭解 BGP 動態路由功能的運作機制和使用限制。更多資訊,請參閱設定 BGP 動態路由。

  • 建議您使用自治系統號的私有號碼與阿里雲建立 BGP 連線。自治系統號的私有號碼範圍請自行查閱文件。

65530

LocalBgpIp

string

否

隧道本端(阿里雲側)的 BGP 位址。該位址為 BGP 網段內的一個 IP 位址。

169.254.10.1

TunnelCidr

string

否

隧道的 BGP 網段。

該網段需是一個在 169.254.0.0/16 內的遮罩長度為 30 的網段,且不能是 169.254.0.0/30、169.254.1.0/30、169.254.2.0/30、169.254.3.0/30、169.254.4.0/30、169.254.5.0/30、169.254.6.0/30 和 169.254.169.252/30。

說明

在一個 VPN 閘道器執行個體下,每個隧道的 BGP 網段需保持唯一。

169.254.10.0/30

TunnelIkeConfig

object

否

第一階段協商的設定資訊。

IkeAuthAlg

string

否

第一階段協商的驗證演算法。

取值:md5、sha1、sha256、sha384、sha512。

md5

IkeEncAlg

string

否

第一階段協商的加密演算法。

取值:aes、aes192、aes256、des 或 3des。

aes

IkeLifetime

integer

否

第一階段協商出的 SA 的生存週期。單位:秒。取值範圍:0~86400。

86400

IkeMode

string

否

IKE 版本的協商模式。取值:

  • main:主模式,協商過程安全性高。

  • aggressive:野蠻模式,協商快速且協商成功率高。

main

IkePfs

string

否

第一階段協商使用的 Diffie-Hellman 金鑰交換演算法。取值:group1、group2、group5、group14。

group2

IkeVersion

string

否

IKE 協定的版本。取值:ikev1 或 ikev2。

相對於 IKEv1 版本,IKEv2 版本簡化了 SA 的協商過程並且對於多網段的場景提供了更好的支援。

ikev1

LocalId

string

否

隧道本端(阿里雲側)的標識,用於第一階段的協商。長度限制為 100 個字元,不能包含空格。預設值為隧道的 IP 位址。

LocalId 支援 FQDN 格式,如果您使用 FQDN 格式,協商模式建議選擇為 aggressive(野蠻模式)。

47.21.XX.XX

Psk

string

否

預共用金鑰,用於隧道與隧道對端之間的身份驗證。

  • 金鑰長度為 1~100 個字元,支援數字、大小寫英文字母以及以下字元,不能包含空格。~!\`@#$%^&*()_-+={}[]|;:',.<>/?

  • 若您未指定預共用金鑰,系統會隨機產生一個 16 位元的字串作為預共用金鑰。您可以呼叫 DescribeVpnConnection 介面查詢系統自動產生的預共用金鑰。

說明

隧道及隧道對端的預共用金鑰需一致,否則系統無法正常建立隧道。

123456****

RemoteId

string

否

隧道對端的標識,用於第一階段的協商。長度限制為 100 個字元,不能包含空格。預設值為隧道關聯的使用者閘道器的 IP 位址。

RemoteId 支援 FQDN 格式,如果您使用 FQDN 格式,協商模式建議選擇為 aggressive(野蠻模式)。

47.42.XX.XX

TunnelIpsecConfig

object

否

第二階段協商的設定資訊。

IpsecAuthAlg

string

否

第二階段協商的驗證演算法。

取值:md5、sha1、sha256、sha384、sha512。

md5

IpsecEncAlg

string

否

第二階段協商的加密演算法。

取值:aes、aes192、aes256、des 或 3des。

aes

IpsecLifetime

integer

否

第二階段協商出的 SA 的生存週期。單位:秒。取值範圍:0~86400。

86400

IpsecPfs

string

否

第二階段協商使用的 Diffie-Hellman 金鑰交換演算法。

取值:disabled、group1、group2、group5、group14。

group2

EnableTunnelsBgp

boolean

否

修改雙隧道模式的 IPsec-VPN 連線時支援設定該參數。

是否為隧道開啟 BGP 功能。取值:true 或 false。

true

返回參數

名稱

類型

描述

樣本值

object

返回結果。

EnableNatTraversal

boolean

IPsec 連線是否已開啟 NAT 穿越功能。取值:

  • false:未開啟。

  • true:已開啟。

僅單隧道模式的 IPsec-VPN 連線會返回該參數。

true

CreateTime

integer

IPsec 連線的建立時間戳記。單位:毫秒。

時間戳記的格式採用 Unix 時間戳記,表示從格林威治時間 1970 年 01 月 01 日 00 時 00 分 00 秒至建立 IPsec 連線時的總時長。

1492753817000

EffectImmediately

boolean

IPsec 連線的設定是否立即生效。

  • true:是,設定完成後系統立即進行 IPsec 協定協商。

  • false:否,當有流量進入時系統才進行 IPsec 協定協商。

false

VpnGatewayId

string

VPN 閘道器執行個體的 ID。

vpn-bp1q8bgx4xnkm2ogj****

LocalSubnet

string

VPC 側的網段。

10.1.1.0/24,10.1.2.0/24

RequestId

string

請求 ID。

7DB79D0C-5F27-4AB5-995B-79BE55102F90

VpnConnectionId

string

IPsec 連線的 ID。

vco-bp1bbi27hojx80nck****

Description

string

IPsec 連線的描述資訊。

description

RemoteSubnet

string

本地資料中心側的網段。

10.2.1.0/24,10.2.2.0/24

CustomerGatewayId

string

IPsec 連線關聯的使用者閘道器 ID。

僅單隧道模式的 IPsec-VPN 連線會返回該參數。

cgw-p0w2jemrcj5u61un8****

Name

string

IPsec 連線的名稱。

nametest

EnableDpd

boolean

IPsec 連線是否已開啟 DPD(對等體存活偵測)功能。

  • false:未開啟。

  • true:已開啟。

僅單隧道模式的 IPsec-VPN 連線會返回該參數。

true

IkeConfig

object

第一階段協商的配置。

僅單隧道模式的 IPsec-VPN 連線會返回 IkeConfig 陣列下的參數。

RemoteId

string

本地資料中心側的標識。支援 FQDN 和 IP 格式,預設為目前選取的使用者閘道器的 IP 位址。

139.18.XX.XX

IkeLifetime

integer

IKE 階段生存時間。單位:秒。

86400

IkeEncAlg

string

IKE 階段加密演算法。

aes

LocalId

string

VPC 側的標識。支援 FQDN 和 IP 格式,預設為目前選取的 VPN 閘道器的 IP 位址。

116.64.XX.XX

IkeMode

string

IKE 協商模式。

  • main:主模式,協商過程安全性高。

  • aggressive:野蠻模式,協商快速且協商成功率高。

main

IkeVersion

string

IKE 協定版本。

  • ikev1

  • ikev2

相對於 IKEv1 版本,IKEv2 版本簡化了 SA 的協商過程並且對於多網段的場景提供了更好的支援。

ikev1

IkePfs

string

IKE 階段 DH 群組。

group2

Psk

string

預共用金鑰。

pgw6dy7d1i8i****

IkeAuthAlg

string

IKE 階段認證演算法。

sha1

IpsecConfig

object

第二階段協商的設定。

僅單隧道模式的 IPsec-VPN 連線會返回 IpsecConfig 陣列下的參數。

IpsecAuthAlg

string

IPsec 階段認證演算法。

sha1

IpsecLifetime

integer

IPsec 階段生存時間。單位:秒。

86400

IpsecEncAlg

string

IPsec 階段加密演算法。

aes

IpsecPfs

string

IPsec 階段 DH 群組。

group2

VcoHealthCheck

object

健康檢查設定。

僅單隧道模式的 IPsec-VPN 連線會返回 VcoHealthCheck 陣列下的參數。

Dip

string

目標 IP。

192.168.1.1

Interval

integer

健康檢查的重試間隔時間,單位:秒。

3

Retry

integer

健康檢查的重試發送封包次數。

3

Sip

string

來源 IP。

10.1.1.1

Enable

string

IPsec 連線是否已開啟健康檢查功能。

  • true:已開啟。

  • false:未開啟。

true

VpnBgpConfig

object

BGP 設定資訊。

僅單隧道模式的 IPsec-VPN 連線會返回 VpnBgpConfig 陣列下的參數。

Status

string

BGP 的協商狀態。

  • success:正常。

  • false:異常。

success

PeerBgpIp

string

本地 IDC 側的 BGP 位址。

169.254.11.2

TunnelCidr

string

IPsec 連線的 BGP 網段。

169.254.11.0/30

EnableBgp

string

BGP 的開啟狀態。

  • true:已開啟。

  • false:未開啟。

true

LocalBgpIp

string

阿里雲側的 BGP 位址。

169.254.11.1

PeerAsn

integer

本地資料中心側的自治系統號。

65531

LocalAsn

integer

阿里雲側的自治系統號。

65530

TunnelOptionsSpecification

object

TunnelOptions

array<object>

IPsec 連線的通道設定資訊。

僅雙隧道模式的 IPsec-VPN 連線會返回 TunnelOptionsSpecification 陣列下的參數。

array<object>

通道的配置資訊。

CustomerGatewayId

string

通道關聯的使用者閘道器 ID。

cgw-p0wy363lucf1uyae8****

EnableDpd

boolean

通道是否已開啟 DPD(對等體存活偵測)功能。

  • false:未開啟。

  • true:已開啟。

true

EnableNatTraversal

boolean

通道是否已開啟 NAT 穿越功能。

  • false:未開啟。

  • true:已開啟。

true

InternetIp

string

通道阿里雲側閘道器 IP 位址。

47.21.XX.XX

RemoteCaCertificate

string

通道對端的 CA 憑證。

僅 VPN 閘道器執行個體的類型為國密型時才會返回目前參數。

-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----

Role

string

隧道的角色。

  • master:表示目前隧道為主隧道。

  • slave:表示目前隧道為備隧道。

master

State

string

通道的狀態。

  • active:狀態正常。

  • updating:更新中。

  • deleting:刪除中。

active

TunnelBgpConfig

object

通道的 BGP 配置資訊。

LocalAsn

integer

通道本端(阿里雲側)的自治系統號。

65530

LocalBgpIp

string

通道本端(阿里雲側)的 BGP 位址。

169.254.10.1

PeerAsn

integer

通道對端的自治系統號。

65531

PeerBgpIp

string

通道對端的 BGP 位址。

169.254.10.2

TunnelCidr

string

通道的 BGP 網段。

169.254.10.0/30

TunnelId

string

隧道 ID。

tun-opsqc4d97wni27****

TunnelIkeConfig

object

第一階段協商的配置。

IkeAuthAlg

string

IKE 階段認證演算法。

sha1

IkeEncAlg

string

IKE 階段加密演算法。

aes

IkeLifetime

integer

IKE 階段生存時間。單位:秒。

86400

IkeMode

string

IKE 協商模式。

  • main:主模式,協商過程安全性高。

  • aggressive:野蠻模式,協商快速且協商成功率高。

main

IkePfs

string

IKE 階段 DH 群組。

group2

IkeVersion

string

IKE 協定版本。

ikev1

LocalId

string

通道本端(阿里雲側)的標識。

47.21.XX.XX

Psk

string

預共用金鑰。

123456****

RemoteId

string

通道對端的標識。

47.42.XX.XX

TunnelIpsecConfig

object

第二階段協商的配置。

IpsecAuthAlg

string

IPsec 階段認證演算法。

sha1

IpsecEncAlg

string

IPsec 階段加密演算法。

aes

IpsecLifetime

integer

IPsec 階段生存時間。單位:秒。

86400

IpsecPfs

string

IPsec 階段 DH 群組。

group2

ZoneNo

string

通道部署的可用區。

ap-southeast-5a

EnableTunnelsBgp

boolean

通道 BGP 的開啟狀態。

  • true:已開啟。

  • false:未開啟。

僅雙通道模式的 IPsec-VPN 連線會返回該參數。

true

ResourceGroupId

string

IPsec 連線所屬的資源群組 ID。

IPsec 連線與其關聯的 VPN 閘道器執行個體的資源群組相同。您可以呼叫 ListResourceGroups 介面查詢資源群組資訊。

rg-acfmzs372yg****

樣本

正常返回樣本

JSON格式

{
  "EnableNatTraversal": true,
  "CreateTime": 1492753817000,
  "EffectImmediately": false,
  "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
  "LocalSubnet": "10.1.1.0/24,10.1.2.0/24",
  "RequestId": "7DB79D0C-5F27-4AB5-995B-79BE55102F90",
  "VpnConnectionId": "vco-bp1bbi27hojx80nck****",
  "Description": "description",
  "RemoteSubnet": "10.2.1.0/24,10.2.2.0/24",
  "CustomerGatewayId": "cgw-p0w2jemrcj5u61un8****",
  "Name": "nametest",
  "EnableDpd": true,
  "IkeConfig": {
    "RemoteId": "139.18.XX.XX",
    "IkeLifetime": 86400,
    "IkeEncAlg": "aes",
    "LocalId": "116.64.XX.XX",
    "IkeMode": "main",
    "IkeVersion": "ikev1",
    "IkePfs": "group2",
    "Psk": "pgw6dy7d1i8i****",
    "IkeAuthAlg": "sha1"
  },
  "IpsecConfig": {
    "IpsecAuthAlg": "sha1",
    "IpsecLifetime": 86400,
    "IpsecEncAlg": "aes",
    "IpsecPfs": "group2"
  },
  "VcoHealthCheck": {
    "Dip": "192.168.1.1",
    "Interval": 3,
    "Retry": 3,
    "Sip": "10.1.1.1",
    "Enable": "true"
  },
  "VpnBgpConfig": {
    "Status": "success",
    "PeerBgpIp": "169.254.11.2",
    "TunnelCidr": "169.254.11.0/30",
    "EnableBgp": "true",
    "LocalBgpIp": "169.254.11.1",
    "PeerAsn": 65531,
    "LocalAsn": 65530
  },
  "TunnelOptionsSpecification": {
    "TunnelOptions": [
      {
        "CustomerGatewayId": "cgw-p0wy363lucf1uyae8****",
        "EnableDpd": true,
        "EnableNatTraversal": true,
        "InternetIp": "47.21.XX.XX",
        "RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----",
        "Role": "master",
        "State": "active",
        "TunnelBgpConfig": {
          "LocalAsn": 65530,
          "LocalBgpIp": "169.254.10.1",
          "PeerAsn": 65531,
          "PeerBgpIp": "169.254.10.2",
          "TunnelCidr": "169.254.10.0/30"
        },
        "TunnelId": "tun-opsqc4d97wni27****",
        "TunnelIkeConfig": {
          "IkeAuthAlg": "sha1",
          "IkeEncAlg": "aes",
          "IkeLifetime": 86400,
          "IkeMode": "main",
          "IkePfs": "group2",
          "IkeVersion": "ikev1",
          "LocalId": "47.21.XX.XX",
          "Psk": "123456****",
          "RemoteId": "47.42.XX.XX"
        },
        "TunnelIpsecConfig": {
          "IpsecAuthAlg": "sha1",
          "IpsecEncAlg": "aes",
          "IpsecLifetime": 86400,
          "IpsecPfs": "group2"
        },
        "ZoneNo": "ap-southeast-5a"
      }
    ]
  },
  "EnableTunnelsBgp": true,
  "ResourceGroupId": "rg-acfmzs372yg****"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 VpnGateway.Configuring The specified service is configuring.
400 VpnGateway.FinancialLocked The specified service is financial locked.
400 InvalidName The name is not valid
400 VpnRouteEntry.AlreadyExists The specified route entry is already exist. 該路由已存在。
400 VpnRouteEntry.Conflict The specified route entry has conflict. 路由項目存在衝突。
400 NotSupportVpnConnectionParameter.IpsecPfs The specified vpn connection ipsec Ipsec Pfs is not support. IPsec 連線中指定的 Pfs 參數不支援。
400 NotSupportVpnConnectionParameter.IpsecAuthAlg The specified vpn connection ipsec Auth Alg is not support. IPsec 連線中指定的驗證演算法不支援。
400 VpnRouteEntry.ConflictSSL The specified route entry has conflict with SSL client. 路由項目與SSL用戶端衝突。
400 VpnRouteEntry.BackupRoute Validate backup route entry failed. 主備路由條目校驗失敗。
400 VpnRouteEntry.InvalidWeight Invalid route entry weight value. 路由權重值不合法。
400 QuotaExceeded.PBR The policy-based routes has reached the upper limit. 建立的策略路由條數已達上限。
400 OperationUnsupported.SetDPD Current version of the VPN does not support setting DPD. 當前VPN閘道版本不支援DPD功能。
400 OperationUnsupported.SetNatTraversal Current version of the VPN does not support setting NAT traversal. 當前VPN閘道版本不支援NAT穿越功能。
400 QuotaExceeded.PolicyBasedRoute The maximum number of policy-based routes is exceeded. Existing routes: %s. Routes to be created: %s. Maximum routes: %s. 策略路由條數已達上限,當前已有%s條,本次將建立%s條,上限為%s條。
400 MissingParameter.TunnelCidr The parameter TunnelCidr is mandatory when BGP is enabled. 開啟 BGP 時,隧道 CIDR 參數是必填項。
400 OperationUnsupported.EnableBgp Current version of the VPN does not support enable BGP. 目前版本的 VPN 不支援開啟 BGP。
400 MissingParam.CustomerGatewayAsn Asn of customer gateway is mandatory when BGP is enabled. 開啟BGP時,客戶閘道的自治系統號不可以為空。
400 IllegalParam.LocalAsn The specified LocalAsn is invalid. 本端自治系統號不合法。
400 IllegalParam.BgpConfig The specified BgpConfig is invalid. 指定的 BGP 設定不合法。
400 IllegalParam.EnableBgp VPN connection must enable BGP when VPN gateway has enabled BGP. 當 VPN 閘道器啟用 BGP 時,VPN 連線必須啟用 BGP。
400 IllegalParam.TunnelCidr The specified TunnelCidr is invalid. 參數 TunnelCidr 不合法。
400 InvalidLocalBgpIp.Malformed The specified LocalBgpIp is malformed. 指定的本端 BGP 的 IP 異常。
400 IllegalParam.LocalBgpIp The specified LocalBgpIp is invalid. 本端BGP位址不合法。
400 IllegalParam.LocalSubnet The specified "LocalSubnet" (%s) is invalid. 本端網段(%s)不合法。
400 IllegalParam.RemoteSubnet The specified "RemoteSubnet" (%s) is invalid. 對端網段(%s)不合法。
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. 當VPN閘道器所屬VPC加入到的雲端企業網且開啟了路由同步時,VPN閘道器不能開啟BGP。
400 InvalidTunnelCidr.Malformed The specified TunnelCidr is malformed. 指定的隧道 CIDR 異常。
400 CustomerGateway.ConflictRouteEntry The specified customer gateway has conflict with route entry. 當前使用者閘道和路由存在衝突。
400 VpnTask.CONFLICT Vpn task has conflict. VPN 操作存在衝突,請稍後重試。
400 OperationFailed.RouteConflictWithIPsecServer Operation failed because the route to create conflicts with the client IP pool of the IPsec server. 路由的目標網段和 IPsec 伺服器端的用戶端網段衝突。
400 IllegalParam.TunnelId The specified TunnelId is invalid. TunnelId參數非法。
400 IllegalParam.Role The specified Role is invalid. Role參數不合法。
400 VpnConnectionParamInvalid.SameVpnAndCgwDifferentIkeConfigs IPSec connections associated with the same user gateway and VPN gateway should have the same pre-shared key and IKE configuration. 偵測到多個IPsec連線關聯了相同的VPN閘道器和使用者閘道器,多個IPsec連線的預共用金鑰和IKE階段的設定參數需保持相同。
400 VpnConnectionParamInvalid.SameVpnAndCgwTrafficSelectorOverlap Traffic selectors of IPSec connections associated with the same user gateway and VPN gateway should not overlap. 偵測到多個IPsec連線關聯了相同的VPN閘道器和使用者閘道器,多個IPsec連線的感興趣流網段不能重疊。
400 ModifyIkeV1WithMultiRoutes.Invalid Failed to modify VPN connection parameters. Multi-network is configured while using IkeV1 protocol. 修改VPN連線參數失敗,在使用IKEv1協定的同時設定了多網端。
400 Vco.StatusNotSupport The current VPN connection state does not support this operation. 目前的執行個體狀態不支援該操作。
400 IkeVersionInvalid.GcmIncompatible Ikev1 does not support IkeEncAlg of gcm16. IKEv1 不支援 IKE 加密演算法,僅設定 gcm16 演算法。
400 EncAlgInvalid.DesIncompatible Des/3des in IkeEncAlg and IpsecEncAlg does not support multi algorithm. IKE 加密演算法以及 IPsec 加密演算法中,DES/3DES 不支援多演算法相容。
400 CustomerGateway.ConflictVpnIp The specified customer gateway has conflict with vpn gateway ip. IPSec連線關聯的使用者閘道器與VPN閘道器不應該有相同的閘道器IP位址。
400 CustomerGateway.AsnNotConfigured ASN of CustomerGateway is required when enabling BGP on an IPSec connection. IPSec 連線開啟 BGP 時,需要在使用者閘道器上設定 ASN。
500 OperationFailed.RouteConflictWithIPsecServer Operation failed because the specified route conflicts with IPsec server. 路由的目標網段和 IPsec 伺服器端的用戶端網段衝突。
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. 您沒有權限操作指定資源,請申請權限後再操作。
404 InvalidVpnConnectionInstanceId.NotFound The specified vpn connection instance id does not exist. 指定的VPN連線不存在,請您檢查該VPN連線ID是否正確。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情。