接口说明
-
如果要修改双隧道模式的 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 连接的配置信息。
流控信息
请求参数
| 字段名称 | 字段详情 |
|---|---|
RegionIdstring | IPsec 连接所在的地域 ID。 展开详情 示例值: cn-shanghai参考取值来源: DescribeRegions |
ClientTokenstring | 客户端 Token，用于保证请求的幂等性。展开详情 示例值:02fb3da4-130e-11e9-8e44-0016e04115b |
VpnConnectionIdstring | IPsec 连接的 ID。 示例值:vco-bp1bbi27hojx80nck****参考取值来源: CreateVpnConnection DiagnoseVpnConnections DescribeVpnConnections ModifyVpnAttachmentAttribute |
Namestring | IPsec 连接的名称。 展开详情 示例值:nametest |
LocalSubnetstring | 需要和本地数据中心互连的 VPC 侧的网段，用于第二阶段协商。展开详情 示例值:10.1.1.0/24,10.1.2.0/24 |
RemoteSubnetstring | 本地数据中心侧的网段，用于第二阶段协商。展开详情 示例值:10.2.1.0/24,10.2.2.0/24 |
EffectImmediatelyboolean | 选择 IPsec 连接的配置是否立即生效。取值：展开详情 示例值:false |
IkeConfigstring | 修改单隧道模式的 IPsec-VPN 连接时支持配置该参数。展开详情 示例值:{"Psk":"pgw6dy7d1i8i****","IkeVersion":"ikev1","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400,"LocalId":"116.64.XX.XX","RemoteId":"139.18.XX.XX"} |
IpsecConfigstring | 修改单隧道模式的 IPsec-VPN 连接时支持配置该参数。展开详情 示例值:{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}参考取值来源: DownloadVpnConnectionConfig ListIpsecServers |
HealthCheckConfigstring | 修改单隧道模式的 IPsec-VPN 连接时支持配置该参数。展开详情 示例值:{"enable":"true","dip":"192.168.1.1","sip":"10.1.1.1","interval":"3","retry":"3"} |
AutoConfigRouteboolean | 是否自动发布路由。取值：展开详情 示例值:true |
EnableDpdboolean | 修改单隧道模式的 IPsec-VPN 连接时支持配置该参数。展开详情 示例值:true |
EnableNatTraversalboolean | 修改单隧道模式的 IPsec-VPN 连接时支持配置该参数。展开详情 示例值:true |
BgpConfigstring | 修改单隧道模式的 IPsec-VPN 连接时支持配置该参数。展开详情 示例值:{"EnableBgp":"true","LocalAsn":"65530","TunnelCidr":"169.254.11.0/30","LocalBgpIp":"169.254.11.1"} |
RemoteCaCertificatestring | 修改单隧道模式的 IPsec-VPN 连接时支持配置该参数。展开详情 示例值:-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE----- |
TunnelOptionsSpecificationarray<object> | 修改隧道的配置。展开详情 |
EnableTunnelsBgpboolean | 修改双隧道模式的 IPsec-VPN 连接时支持配置该参数。展开详情 示例值:true |
返回参数
| 字段名称 | 字段详情 |
|---|---|
EnableNatTraversalboolean | IPsec 连接是否已开启 NAT 穿越功能。取值：展开详情 示例值:true |
CreateTimeinteger<int64> | |
EffectImmediatelyboolean | IPsec 连接的配置是否立即生效。展开详情 示例值:false |
VpnGatewayIdstring | VPN 网关实例的 ID。 示例值:vpn-bp1q8bgx4xnkm2ogj**** |
LocalSubnetstring | VPC 侧的网段。 示例值:10.1.1.0/24,10.1.2.0/24 |
RequestIdstring | 请求 ID。 示例值:7DB79D0C-5F27-4AB5-995B-79BE55102F90 |
VpnConnectionIdstring | IPsec 连接的 ID。 示例值:vco-bp1bbi27hojx80nck**** |
Descriptionstring | IPsec 连接的描述信息。 示例值:description |
RemoteSubnetstring | 本地数据中心侧的网段。 示例值:10.2.1.0/24,10.2.2.0/24 |
CustomerGatewayIdstring | IPsec 连接关联的用户网关 ID。展开详情 示例值:cgw-p0w2jemrcj5u61un8**** |
Namestring | IPsec 连接的名称。 示例值:nametest |
EnableDpdboolean | IPsec 连接是否已开启 DPD（对等体存活检测）功能。展开详情 示例值:true |
IkeConfigobject | 第一阶段协商的配置。展开详情 |
IpsecConfigobject | 第二阶段协商的配置。展开详情 |
VcoHealthCheckobject | 健康检查配置。展开详情 |
VpnBgpConfigobject | BGP 配置信息。展开详情 |
TunnelOptionsSpecificationobject | |
EnableTunnelsBgpboolean | 隧道 BGP 的开启状态。展开详情 示例值:true |
ResourceGroupIdstring | IPsec 连接所属的资源组 ID。展开详情 示例值:rg-acfmzs372yg**** |
返回示例
错误码
变更历史
| 变更时间 | 变更内容概要 | 操作 | |
|---|---|---|---|
| 2024-10-24 | |||
| 2024-01-04 | |||
| 2023-10-23 | |||
| 2023-10-19 | |||
| 2023-08-01 | |||
| 2023-06-30 | |||
| 2022-12-08 |