功能介紹
根據連接ID,更新指定的VPN連接的參數(shù)
URI
PUT /v5/{project_id}/vpn-connection/{vpn_connection_id}
|
名稱 |
類型 |
是否必選 |
說明 |
|---|---|---|---|
|
project_id |
String |
是 |
項目ID,可以通過獲取項目ID獲取項目ID。 |
|
vpn_connection_id |
String |
是 |
VPN連接ID |
請求消息
- 請求參數(shù)
表2 請求參數(shù) 名稱
類型
是否必選
描述
vpn_connection
是
vpn_connection對象
表3 UpdateVpnConnectionRequestBodyContent 名稱
類型
是否必選
描述
name
String
否
- 功能說明:VPN連接名稱
- 取值范圍:1-64個字符,支持數(shù)字、英文字母、中文(\u4e00 - \u9fa5)、_(下劃線)、-(中劃線)。
cgw_id
String
否
- 功能說明:對端網關ID
- 約束:36位UUID
peer_subnets
Array of String
否
tunnel_local_address
String
否
tunnel_peer_address
String
否
psk
String
否
- 功能說明:預共享密鑰。ike版本為v2時,只修改該字段不生效。
- 約束:8-128個字符,只能包含大寫字母、小寫字母、數(shù)字和特殊字符(~!@#$%^()-_+={ },./:;)且至少包含四種字符的三種。
policy_rules
否
- 功能說明:策略模式的策略規(guī)則組
- 約束:最多填寫5個。style為policy時填寫,為static或bgp時不填。
可以通過查詢VPN連接查看VPN連接的style。
ikepolicy
否
ike策略對象
ipsecpolicy
否
ipsec策略對象
表4 PolicyRule 名稱
類型
是否必選
描述
rule_index
Integer
否
source
String
否
- 功能說明:源地址網段。
- 約束:不能與其他PolicyRule下的source相同。
destination
Array of String
否
表5 UpdateIkePolicy 名稱
類型
是否必選
描述
ike_version
String
否
phase1_negotiation_mode
String
否
authentication_algorithm
String
否
encryption_algorithm
String
否
dh_group
String
否
lifetime_seconds
Integer
否
- 功能說明:表示SA的生存周期,當該生存周期超時后IKE SA將自動更新。修改該字段后需要等協(xié)商一階段老化后生效。
- 取值范圍:60-604800,單位:秒
local_id_type
String
否
local_id
String
否
peer_id_type
String
否
peer_id
String
否
dpd
否
對等體存活檢測對象
表6 UpdateDpd 名稱
類型
是否必選
描述
timeout
Integer
否
- 功能說明:對等體存活檢測報文重傳間隔
- 取值范圍:2-60,單位:秒,不填時默認為15。
interval
Integer
否
- 功能說明:對等體存活檢測空閑時間
- 取值范圍:10-3600,單位:秒,不填時默認為30。
msg
String
否
- 請求樣例
- 更新對端子網。
PUT https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id} { "vpn_connection": { "peer_subnets": [ "192.168.1.0/24" ] } } - 更新策略規(guī)則。
PUT https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id} { "vpn_connection": { "policy_rules": [{ "rule_index": 1, "source": "10.0.0.0/24", "destination": [ "192.168.1.0/24" ] }] } } - 更新生命周期。
PUT https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id} { "vpn_connection": { "ikepolicy": { "lifetime_seconds": 3600 }, "ipsecpolicy": { "lifetime_seconds": 3600 } } } - 更新連接名稱。
PUT https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id} { "vpn_connection": { "name": "vpn_connection_name" } }
- 更新對端子網。
響應消息
- 響應參數(shù)
返回狀態(tài)碼為 200: successful operation
表8 響應Body參數(shù)列表 名稱
類型
描述
vpn_connection
vpn_connection對象
request_id
String
請求ID
表9 ResponseVpnConnection 名稱
類型
描述
id
String
- 功能說明:VPN連接ID
- 格式:36位UUID
name
String
- 功能說明:VPN連接名稱,不填時會自動生成。
- 取值范圍:1-64個字符,支持數(shù)字、英文字母、中文(\u4e00 - \u9fa5)、_(下劃線)、-(中劃線)。
vgw_id
String
- 功能說明:VPN網關ID
- 格式:36位UUID
vgw_ip
String
- 功能說明: VPN網關EIP的ID或接入私網IP
- 格式:36位UUID或點分十進制IPv4地址(如192.168.45.7)
style
String
cgw_id
String
- 功能說明:對端網關ID
- 格式:36位UUID
peer_subnets
Array of String
對端子網。當VPN網關的關聯(lián)模式為ER并且style字段為BGP或POLICY時不返回。
tunnel_local_address
String
路由模式下配置在VPN網關上的tunnel接口地址。僅當style為STATIC或BGP時有效。
tunnel_peer_address
String
路由模式下配置在用戶側設備上的tunnel接口地址。僅當style為STATIC或BGP時有效。
enable_nqa
Boolean
- 功能說明:開啟NQA檢測。僅當style為STATIC時返回。
- 取值范圍:true,false。
policy_rules
策略模式的策略規(guī)則組。當style為POLICY時返回實際的策略規(guī)則組,當style為STATIC或BGP時不返回。
ikepolicy
ike策略對象
ipsecpolicy
ipsec策略對象
created_at
String
創(chuàng)建時間
updated_at
String
最后一次更新時間
enterprise_project_id
String
- 功能說明:企業(yè)項目ID
- 格式:36位UUID。與vgw_id所標識VPN網關的企業(yè)項目ID一致。
connection_monitor_id
String
- 功能說明:VPN連接監(jiān)控ID
- 格式:36位UUID
ha_role
String
- 功能說明:主備模式VPN網關下的連接時,'master'表示主連接,'slave'表示備連接。雙活模式下的連接ha_role都是'master'。
- 默認值:master
表10 PolicyRule 名稱
類型
描述
rule_index
Integer
- 功能說明:規(guī)則ID
- 取值范圍:0-50
source
String
源地址網段
destination
Array of String
目的地址網段。單個網段格式示例:192.168.52.0/24。每個PolicyRule最多返回50個。
表11 IkePolicy 名稱
類型
描述
ike_version
String
- 功能說明:IKE版本號
- 取值范圍:v1, v2。
phase1_negotiation_mode
String
authentication_algorithm
String
- 功能說明:認證算法
- 取值范圍:sha2-512,sha2-384,sha2-256,sha1,md5,sm3。
encryption_algorithm
String
- 功能說明:加密算法
- 取值范圍:aes-256-gcm-16,aes-128-gcm-16,aes-256,aes-192,aes-128,3des,sm4。
dh_group
String
- 功能說明:第一階段密鑰交換使用的DH組,當VPN網關flavor為GM時不返回。
- 取值范圍:group1,group2,group5,group14,group15,group16,group19,group20,group21。
authentication_method
String
lifetime_seconds
Integer
- 功能說明:表示SA的生存周期,當該生存周期超時后IKE SA將自動更新。
- 取值范圍:60-604800,單位:秒。
local_id_type
String
- 功能說明:本端ID類型,當VPN網關flavor為GM時不返回。
- 取值范圍:ip,fqdn。
local_id
String
本端ID。當local_id_type為ip時返回VPN連接所使用的網關IP;當local_id_type為fqdn時返回創(chuàng)建或更新VPN連接時指定的本端ID。
當VPN網關flavor為GM時不返回。
peer_id_type
String
- 功能說明:對端ID類型,當VPN網關flavor為GM時不返回。
- 取值范圍:ip,fqdn,any。
peer_id
String
對端ID。當peer_id_type為ip時返回對端網關的IP;當peer_id_type為fqdn時返回創(chuàng)建或更新VPN連接時指定的對端ID;當peer_id_type為any時不返回。
當VPN網關flavor為GM時不返回。
dpd
對等體存活檢測對象
表12 Dpd 名稱
類型
描述
timeout
Integer
- 功能說明:對等體存活檢測報文重傳間隔
- 取值范圍:2-60,單位:秒。
interval
Integer
- 功能說明:對等體存活檢測空閑時間
- 取值范圍:10-3600,單位:秒。
msg
String
表13 IpsecPolicy 名稱
類型
描述
authentication_algorithm
String
- 功能說明:認證算法
- 取值范圍:sha2-512,sha2-384,sha2-256,sha1,md5,sm3。
encryption_algorithm
String
- 功能說明:加密算法
- 取值范圍:aes-256-gcm-16,aes-128-gcm-16,aes-256,aes-192,aes-128,3des,sm4。
pfs
String
- 功能說明:PFS使用的DH密鑰組,當VPN網關flavor為GM時不返回。
- 取值范圍:group1,group2,group5,group14,group15,group16,group19,group20,group21,disable。
transform_protocol
String
lifetime_seconds
Integer
- 功能說明:表示配置IPSec連接建立的隧道以時間為基準的生存周期。
- 取值范圍:30-604800,單位:秒
encapsulation_mode
String
- 響應樣例
- 更新VPN連接的響應。
{ "vpn_connection": { "id": "98c5af8a-****-****-****-ae2280a6f4c3", "name": "vpn-1655", "vgw_id": "b32d91a4-****-****-****-e907174eb11d", "vgw_ip": "0c464dad-****-****-****-c22bb0eb0bde", "style": "POLICY", "cgw_id": "5247ae10-****-****-****-dd36659a7f5d", "peer_subnets": ["192.168.1.0/24"], "tunnel_local_address": "169.254.56.225/30", "tunnel_peer_address": "169.254.56.226/30", "policy_rules": [{ "rule_index": 1, "source": "10.0.0.0/24", "destination": [ "192.168.1.0/24" ] }], "ikepolicy": { "ike_version": "v2", "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "dh_group": "group15", "authentication_method": "pre-share", "lifetime_seconds": 86400, "local_id_type": "ip", "local_id": "10.***.***.134", "peer_id_type": "ip", "peer_id": "88.***.***.164", "dpd": { "timeout": 15, "interval": 30, "msg": "seq-hash-notify" } }, "ipsecpolicy": { "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "pfs": "group15", "transform_protocol": "esp", "lifetime_seconds": 3600, "encapsulation_mode": "tunnel" }, "created_at": "2022-11-26T13:41:34.626Z", "updated_at": "2022-11-26T13:41:34.626Z", "enterprise_project_id": "0", "ha_role": "master" }, "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae" } - 凍結場景下更新失敗。
{ "error_code": "VPN.0001", "error_msg": "invalid request: ILLEGAL not allowed update vpnConnection", "request_id": "8c833634-4560-7897-7740-a7462f5bcbd4" }
- 更新VPN連接的響應。
狀態(tài)碼
請參見狀態(tài)碼
