调用ModifyVpnGatewayAttribute修改VPN网关的名称和描述信息

调用ModifyVpnGatewayAttribute接口修改VPN网关的名称和描述信息。

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:ModifyVpnGatewayAttribute	Write	VpnGateway acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	VPN网关实例所在的地域ID。您可以通过调用DescribeRegions接口获取地域ID。	ap-southeast-2
ClientToken	string	否	客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。说明若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。	123e4567-e89b-12d3-a456-4266****
VpnGatewayId	string	是	VPN网关实例的ID。	vpn-bp1q8bgx4xnkm2ogj****
Name	string	否	VPN网关的新名称。长度为2～100个字符，不能以`http://`或`https://`开头，需要以大写或小写字母开头，后面可包含大小写字母、数字、下划线（_）、短划线（-）和半角句号（.），不支持其他特殊字符。	myvpn
Description	string	否	VPN网关新的描述信息。描述信息长度为1～100个字符，不能以`http://`或`https://`开头。	test
AutoPropagate	boolean	否	是否将BGP路由自动传播到VPC。取值： true：自动传播。 false：不自动传播。	true

返回参数

名称	类型	描述	示例值
	object	返回结果。
VpcId	string	VPN网关实例所属VPC的ID。	vpc-bp1ub1yt9cvakoel****
Status	string	VPN网关的状态。 init：初始化。 provisioning：准备中。 active：正常。 updating：更新中。 deleting：删除中。	active
InternetIp	string	在VPN网关实例支持创建单隧道模式IPsec-VPN连接的场景下，该地址为VPN网关实例的IP地址，可用于创建IPsec-VPN连接或SSL-VPN连接。在VPN网关实例支持创建双隧道模式IPsec-VPN连接的场景下，该地址为用于创建IPsec-VPN连接的第一个IP地址，不能用于创建SSL-VPN连接。在VPN网关实例支持创建双隧道模式IPsec-VPN连接的场景下，系统会为VPN网关实例分配两个IPsec地址，用于创建双隧道模式的IPsec-VPN连接。	116.62.XX.XX
Spec	string	VPN网关实例的带宽规格。单位：Mbps。	5M
CreateTime	long	VPN网关实例的创建时间戳。单位：毫秒。时间戳的格式采用Unix时间戳，表示从格林威治时间1970年01月01日00时00分00秒至创建VPN网关实例时的总时长。	1492753580000
AutoPropagate	boolean	BGP路由是否自动传播到VPC。取值： true：自动传播。 false：不自动传播。	true
VpnGatewayId	string	VPN网关实例的ID。	vpn-bp1q8bgx4xnkm2ogj****
IntranetIp	string	VPN网关实例的IP地址。当VPN网关的网络类型为私网，且仅支持创建单隧道模式的IPsec-VPN连接时会返回当前参数。	172.27.30.24
EndTime	long	VPN网关实例的到期时间戳。单位：毫秒。时间戳的格式采用Unix时间戳，表示从格林威治时间1970年01月01日00时00分00秒至VPN网关实例到期时的总时长。	1495382400000
VSwitchId	string	VPN网关实例关联的交换机ID。	vsw-bp1y9ovl1cu9ou4tv****
RequestId	string	请求ID。	54B48E3D-DF70-471B-AA93-08E683A1B457
Description	string	VPN网关实例的描述信息。	test
EnableBgp	boolean	VPN网关BGP功能的开启状态。取值： true：开启。 false：未开启。	true
BusinessStatus	string	VPN网关实例的付费状态。取值： Normal：正常。 FinancialLocked：欠费锁定。	Normal
Name	string	VPN网关实例的名称。	test
DisasterRecoveryInternetIp	string	系统为VPN网关实例分配的用于创建IPsec-VPN连接的第二个IP地址。仅支持创建双隧道模式IPsec-VPN连接的VPN网关实例会返回当前参数。	116.11.XX.XX
DisasterRecoveryVSwitchId	string	VPN网关实例关联的第二个交换机ID。仅支持创建双隧道模式IPsec-VPN连接的VPN网关实例会返回当前参数。	vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIp	string	SSL-VPN连接的IP地址。仅支持创建双隧道模式IPsec-VPN连接的公网网络类型的VPN网关实例开启SSL-VPN功能后，才会返回当前参数。	116.33.XX.XX

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
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.	您没有权限操作指定资源，请申请权限后再操作。

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

变更历史

变更时间

变更内容概要

操作

2023-06-30

OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更
	删除错误码：400
	删除错误码：403
	删除错误码：404
出参	OpenAPI 返回结构发生变更