调用ModifyVpnGatewayAttribute接口修改VPN网关的配置。

使用说明

  • ModifyVpnGatewayAttribute接口属于异步接口，即系统先返回VPN网关的信息，但该VPN网关的配置尚未修改成功，系统后台的修改任务仍在进行。您可以调用DescribeVpnGateway查询VPN网关的配置的修改状态：
    • 当VPN网关处于updating状态时，表示VPN网关的配置正在修改中。
    • 当VPN网关处于active状态时，表示VPN网关的配置修改成功。
  • ModifyVpnGatewayAttribute接口不支持并发修改同一个VPN网关的配置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ModifyVpnGatewayAttribute

系统规定参数。取值：ModifyVpnGatewayAttribute。
RegionId String 是 ap-southeast-2

VPN网关实例所在的地域ID。您可以通过调用DescribeRegions接口获取地域ID。

ClientToken String 否 123e4567-e89b-12d3-a456-4266****

客户端Token，用于保证请求的幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。
VpnGatewayId String 是 vpn-bp1q8bgx4xnkm2ogj****

VPN网关实例的ID。

Name String 否 myvpn

VPN网关的新名称。

长度为2～100个字符，不能以http://或https://开头，需要以大写或小写字母开头，后面可包含大小写字母、数字、下划线（_）、短划线（-）和半角句号（.），不支持其他特殊字符。
Description String 否 test

VPN网关新的描述信息。

描述信息长度为1～100个字符，不能以http://或https://开头。
AutoPropagate Boolean 否 true

是否将BGP路由自动传播到VPC。取值：

  • true：自动传播。
  • false：不自动传播。

返回数据

名称 类型 示例值 描述
VpcId String vpc-bp1ub1yt9cvakoel****

VPN网关实例所属VPC的ID。
Status String active

VPN网关的状态。

  • init：初始化。
  • provisioning：准备中。
  • active：正常。
  • updating：更新中。
  • deleting：删除中。
InternetIp String 116.62.XX.XX
  • 在VPN网关实例支持创建单隧道模式IPsec-VPN连接的场景下，该地址为VPN网关实例的IP地址，可用于创建IPsec-VPN连接或SSL-VPN连接。

  • 在VPN网关实例支持创建双隧道模式IPsec-VPN连接的场景下，该地址为用于创建IPsec-VPN连接的第一个IP地址，不能用于创建SSL-VPN连接。

    在VPN网关实例支持创建双隧道模式IPsec-VPN连接的场景下，系统会为VPN网关实例分配两个IPsec地址，用于创建双隧道模式的IPsec-VPN连接。
Spec String 5M

VPN网关实例的带宽规格。单位：Mbps。
CreateTime Long 1492753580000

VPN网关实例的创建时间戳。单位：毫秒。

时间戳的格式采用Unix时间戳，表示从格林威治时间1970年01月01日00时00分00秒至创建VPN网关实例时的总时长。
AutoPropagate Boolean true

BGP路由是否自动传播到VPC。取值：

  • true：自动传播。
  • false：不自动传播。
VpnGatewayId String vpn-bp1q8bgx4xnkm2ogj****

VPN网关实例的ID。
IntranetIp String 172.27.30.24

VPN网关实例的IP地址。

当VPN网关的网络类型为私网，且仅支持创建单隧道模式的IPsec-VPN连接时会返回当前参数。
EndTime Long 1495382400000

VPN网关实例的到期时间戳。单位：毫秒。

时间戳的格式采用Unix时间戳，表示从格林威治时间1970年01月01日00时00分00秒至VPN网关实例到期时的总时长。
VSwitchId String vsw-bp1y9ovl1cu9ou4tv****

VPN网关实例关联的交换机ID。
RequestId String 54B48E3D-DF70-471B-AA93-08E683A1B457

请求ID。
Description String test

VPN网关实例的描述信息。
EnableBgp Boolean true

VPN网关BGP功能的开启状态。取值：

  • true：开启。
  • false：未开启。
BusinessStatus String Normal

VPN网关实例的付费状态。取值：

  • Normal：正常。
  • FinancialLocked：欠费锁定。
Name String test

VPN网关实例的名称。
DisasterRecoveryInternetIp String 116.11.XX.XX

系统为VPN网关实例分配的用于创建IPsec-VPN连接的第二个IP地址。

仅支持创建双隧道模式IPsec-VPN连接的VPN网关实例会返回当前参数。
DisasterRecoveryVSwitchId String vsw-p0w95ql6tmr2ludkt****

VPN网关实例关联的第二个交换机ID。

仅支持创建双隧道模式IPsec-VPN连接的VPN网关实例会返回当前参数。
SslVpnInternetIp String 116.33.XX.XX

SSL-VPN连接的IP地址。

仅支持创建双隧道模式IPsec-VPN连接的公网网络类型的VPN网关实例开启SSL-VPN功能后，才会返回当前参数。

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyVpnGatewayAttribute
&RegionId=ap-southeast-2
&ClientToken=123e4567-e89b-12d3-a456-4266****
&VpnGatewayId=vpn-bp1q8bgx4xnkm2ogj****
&Name=myvpn
&Description=test
&AutoPropagate=true
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyVpnGatewayAttributeResponse>
    <VpcId>vpc-bp1ub1yt9cvakoel****</VpcId>
    <Status>active</Status>
    <InternetIp>116.62.XX.XX</InternetIp>
    <Spec>5M</Spec>
    <CreateTime>1492753580000</CreateTime>
    <AutoPropagate>true</AutoPropagate>
    <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj****</VpnGatewayId>
    <EndTime>1495382400000</EndTime>
    <VSwitchId>vsw-bp1y9ovl1cu9ou4tv****</VSwitchId>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B457</RequestId>
    <Description>test</Description>
    <EnableBgp>true</EnableBgp>
    <BusinessStatus>Normal</BusinessStatus>
    <DisasterRecoveryVSwitchId>vsw-p0w95ql6tmr2ludkt****</DisasterRecoveryVSwitchId>
    <DisasterRecoveryInternetIp>116.11.XX.XX</DisasterRecoveryInternetIp>
    <SslVpnInternetIp>116.33.XX.XX</SslVpnInternetIp>
    <Name>test</Name>
</ModifyVpnGatewayAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "VpcId" : "vpc-bp1ub1yt9cvakoel****",
  "Status" : "active",
  "InternetIp" : "116.62.XX.XX",
  "Spec" : "5M",
  "CreateTime" : 1492753580000,
  "AutoPropagate" : true,
  "VpnGatewayId" : "vpn-bp1q8bgx4xnkm2ogj****",
  "EndTime" : 1495382400000,
  "VSwitchId" : "vsw-bp1y9ovl1cu9ou4tv****",
  "RequestId" : "54B48E3D-DF70-471B-AA93-08E683A1B457",
  "Description" : "test",
  "EnableBgp" : true,
  "BusinessStatus" : "Normal",
  "DisasterRecoveryVSwitchId" : "vsw-p0w95ql6tmr2ludkt****",
  "DisasterRecoveryInternetIp" : "116.11.XX.XX",
  "SslVpnInternetIp" : "116.33.XX.XX",
  "Name" : "test"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidName The name is not valid 该名称格式不合法。
400 InvalidDescription The description is not valid 描述格式不合法。
400 OperationUnsupported.EnableBgp Current version of the VPN does not support enable BGP. 当前版本的VPN不支持开启BGP
400 OperationFailed.VpnConnectionExist Auto propagate cannot be closed when VPN connections with BGP enabled exist. 当存在已开启BGP的VPN连接时，路由自动传播无法关闭。
400 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist. 指定的 VPN 网关不存在，请您检查 VPN 网关是否正确。
400 VpnGateway.Configuring The specified service is configuring. 服务正在配置中，请您稍后再试。
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加入到的CEN开启了FULL模式时，VPN网关不能开启BGP。
403 Forbidden.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. 您没有权限操作指定资源，请申请权限后再操作。

访问错误中心查看更多错误码。