AI 助理
备案控制台
文档
输入文档关键字查找
首页 专有网络VPC 开发参考 API参考 API目录 VPN网关 ModifyVpnGatewayAttribute - 修改VPN网关的名称和描述信息

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:ModifyVpnGatewayAttributeupdate
  • VpnGateway
    acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}
    无
无

请求参数

名称类型必填描述示例值
RegionIdstring是

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

cn-hangzhou
ClientTokenstring否

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

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

说明 若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-4266****
VpnGatewayIdstring是

VPN 网关实例的 ID。

vpn-bp1q8bgx4xnkm2ogj****
Namestring否

VPN 网关的新名称。

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

myvpn
Descriptionstring否

VPN 网关新的描述信息。

描述信息长度为 1～100 个字符。

test
AutoPropagateboolean否

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

  • true：自动传播。

  • false：不自动传播。

true

返回参数

名称类型描述示例值
object

返回结果。

VpcIdstring

VPN 网关实例所属 VPC 的 ID。

vpc-bp1ub1yt9cvakoel****
Statusstring

VPN 网关的状态。

  • init：初始化。
  • provisioning：准备中。
  • active：正常。
  • updating：更新中。
  • deleting：删除中。
active
InternetIpstring

  • 在 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
Specstring

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

5M
CreateTimelong

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

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

1492753580000
AutoPropagateboolean

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

  • true：自动传播。

  • false：不自动传播。

true
VpnGatewayIdstring

VPN 网关实例的 ID。

vpn-bp1q8bgx4xnkm2ogj****
IntranetIpstring

VPN 网关实例的 IP 地址。

仅支持创建单隧道模式 IPsec-VPN 连接的 VPN 网关实例会返回当前参数。

172.27.30.24
EndTimelong

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

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

1495382400000
VSwitchIdstring

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

vsw-bp1y9ovl1cu9ou4tv****
RequestIdstring

请求 ID。

54B48E3D-DF70-471B-AA93-08E683A1B457
Descriptionstring

VPN 网关实例的描述信息。

test
EnableBgpboolean

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

  • true：开启。

  • false：未开启。

true
BusinessStatusstring

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

  • Normal：正常。
  • FinancialLocked：欠费锁定。
Normal
Namestring

VPN 网关实例的名称。

test
DisasterRecoveryInternetIpstring

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

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

116.11.XX.XX
DisasterRecoveryVSwitchIdstring

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

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

vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIpstring

SSL-VPN 连接的 IP 地址。

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

116.33.XX.XX
ResourceGroupIdstring

VPN 网关实例所属的资源组 ID。

您可以调用 ListResourceGroups 接口查询资源组信息。

rg-acfmzs372yg****

示例

正常返回示例

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",
  "ResourceGroupId": "rg-acfmzs372yg****"
}

错误码

HTTP status code错误码错误信息描述
400InvalidNameThe name is not valid该名称格式不合法。
400InvalidDescriptionThe description is not valid描述格式不合法。
400OperationUnsupported.EnableBgpCurrent version of the VPN does not support enable BGP.当前版本的VPN不支持开启BGP
400OperationFailed.VpnConnectionExistAuto propagate cannot be closed when VPN connections with BGP enabled exist.当存在已开启BGP的VPN连接时，路由自动传播无法关闭。
400InvalidVpnGatewayInstanceId.NotFoundThe specified vpn gateway instance id does not exist.指定的 VPN 网关不存在，请您检查 VPN 网关是否正确。
400VpnGateway.ConfiguringThe specified service is configuring.服务正在配置中，请您稍后再试。
400OperationFailed.CenLevelNotSupportWhen the VPC to which the VPN gateway belongs is attached to a FULL-mode CEN, the VPN gateway cannot enable BGP.当VPN网关所属VPC加入到的云企业网且开启了路由同步时，VPN网关不能开启BGP。
403Forbidden.SubUserUser not authorized to operate on the specified resource as your account is created by another user.您没有权限操作该资源，请您申请操作权限后再试。
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源，请申请权限后再操作。

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

变更历史

变更时间变更内容概要操作
2023-10-19OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-06-30OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
上一篇：DissociateVpnGatewayWithCertificate - 分离VPN网关与证书下一篇：MoveVpnResourceGroup - 修改VPN网关资源所属的资源组
文档推荐