调用ModifyTunnelAttribute接口修改高可用VPN的隧道配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:ModifyTunnelAttribute | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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.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 |
| 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-01-04 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2023-08-21 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
|