調用ModifyTunnelAttribute接口修改高可用VPN的隧道配置信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:ModifyTunnelAttribute | update | *VpnConnection acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 02fb3da4-130e-11e9-8e44-0016e04115b |
| TunnelOptionsSpecification | object | 否 | 修改隧道的配置。 | |
| EnableDpd | boolean | 否 | 是否開啟 DPD（對等體存活檢測）功能。取值：
| true |
| EnableNatTraversal | boolean | 否 | 是否開啟 NAT 穿越功能。取值：
| true |
| RemoteCaCertificate | string | 否 | 在國密型 VPN 網關下使用 IPsec 連接時，對端的 CA 證書。 | -----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE----- |
| TunnelBgpConfig | object | 否 | 修改隧道的 BGP 配置。 如果隧道之前并未開啟 BGP 功能，您需要調用 ModifyVpnConnectionAttribute 接口為隧道開啟 BGP 功能并添加 BGP 配置。 | |
| LocalAsn | long | 否 | 隧道本端自治系統號。自治系統號取值范圍：1~4294967295。 | 65530 |
| LocalBgpIp | string | 否 | 隧道本端的 BGP IP 地址。該地址需是 TunnelCidr 內的一個 IP 地址。 | 169.254.11.1 |
| TunnelCidr | string | 否 | 隧道本端 BGP IP 地址所屬網段。 該網段需是一個在 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 隧道網段需保持唯一。
| 169.254.11.0/30 |
| TunnelIkeConfig | object | 否 | 修改隧道 IKE 階段（第一階段）配置。 | |
| IkeAuthAlg | string | 否 | 第一階段協商的認證算法。
| sha1 |
| IkeEncAlg | string | 否 | 第一階段協商的加密算法。
| aes |
| IkeLifetime | long | 否 | 第一階段協商出的 SA 的生存周期。單位：秒。取值范圍：0~86400。 | 86400 |
| IkeMode | string | 否 | IKE 版本的協商模式。取值：
| main |
| IkePfs | string | 否 | 第一階段協商使用的 Diffie-Hellman 密鑰交換算法。取值：group1、group2、group5、group14。 | group2 |
| IkeVersion | string | 否 | IKE 協議的版本。取值：ikev1 或 ikev2。 | ikev2 |
| LocalId | string | 否 | 隧道本端的標識。長度限制為 100 個字符，，不能包含空格，支持 FQDN 和 IP 格式。默認值為隧道的 IP 地址。 | 47.XX.XX.87 |
| Psk | string | 否 | 預共享密鑰，用于隧道及對端之間的身份認證。
說明
隧道及隧道對端配置的預共享密鑰必須一致，否則系統無法成功建立隧道。
| 123456**** |
| RemoteId | string | 否 | 隧道對端的標識。長度限制為 100 個字符，不能包含空格，支持 FQDN 和 IP 格式。默認值為隧道關聯的用戶網關實例的 IP 地址。 | 47.XX.XX.207 |
| TunnelIpsecConfig | object | 否 | 修改隧道 IPsec 階段（第二階段）的配置。 | |
| IpsecAuthAlg | string | 否 | 第二階段協商的認證算法。
| sha1 |
| IpsecEncAlg | string | 否 | 第二階段協商的加密算法。
| aes |
| IpsecLifetime | long | 否 | 第二階段協商出的 SA 的生存周期。單位：秒。取值范圍：0~86400。 | 86400 |
| IpsecPfs | string | 否 | 第二階段協商使用的 Diffie-Hellman 密鑰交換算法。取值：disabled、group1、group2、group5、group14。 | group2 |
| CustomerGatewayId | string | 否 | 隧道關聯的用戶網關實例 ID。 | cgw-1nmwbpgrp7ssqm1yn**** |
| RegionId | string | 否 | IPsec 連接所屬的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| VpnConnectionId | string | 是 | IPsec 連接 ID。 | vco-gw69vm1i71y354**** |
| TunnelId | string | 是 | 隧道 ID。 | tun-gbyz2e070xzo93**** |
返回參數
示例
正常返回示例
JSON格式
{
"TunnelId": "tun-gbyz2e070xzo93****",
"RequestId": "E6F36FF0-9544-3AEE-8673-A4647D50064C",
"TunnelIkeConfig": {
"IkeAuthAlg": "sha1",
"IkeEncAlg": "aes",
"IkeLifetime": 86400,
"IkeMode": "main",
"IkePfs": "group2",
"IkeVersion": "ikev2",
"LocalId": "47.XX.XX.87",
"Psk": "123456****",
"RemoteId": "47.XX.XX.207"
},
"TunnelIpsecConfig": {
"IpsecAuthAlg": "sha1",
"IpsecEncAlg": "aes",
"IpsecLifetime": 86400,
"IpsecPfs": "group2"
},
"TunnelBgpConfig": {
"EnableBgp": true,
"LocalAsn": 65530,
"LocalBgpIp": "169.254.11.1",
"PeerAsn": 65531,
"PeerBgpIp": "169.254.11.2",
"TunnelCidr": "169.254.11.0/30"
},
"EnableNatTraversal": true,
"EnableDpd": true,
"RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----",
"CustomerGatewayId": "cgw-p0wx48ayhrygitm80****",
"Role": "master",
"ZoneNo": "cn-hangzhou-h",
"InternetIp": "47.XX.XX.87",
"State": "active"
}錯誤碼
| 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 | 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 | IllegalParam.LocalAsn | The param of LocalAsn is illegal | LocalAsn參數不合法 |
| 400 | IllegalParam.LocalBgpIp | The specified LocalBgpIp is invalid. | 本端BGP地址不合法。 |
| 400 | VpnGateway.task.conflict | The VPN is in the configuration state, please wait a while before operating. | 該VPN處于正在配置狀態，請稍等一會再進行操作。 |
| 400 | ModifyIkeV1WithMultiRoutes.Invalid | Failed to modify VPN connection parameters. Multi-network is configured while using IkeV1 protocol. | 修改VPN連接參數失敗，在使用IkeV1協議的同時配置了多網端。 |
| 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是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-10-24 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-01-04 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-08-21 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |