Modify the name and description of a VPN gateway.

Request parameters

Name Type Required Description
Action String Yes

The action to perform. Valid value:

ModifyVpnGatewayAttribute
RegionId String Yes The region of the VPN gateway.

You can obtain the region ID by calling the DescribeRegions API.

VpnGatewayId String Yes

The ID of the VPN gateway.
ClientToken String No

A client token used to guarantee the idempotence of requests. 

This parameter value is generated by the client and must be unique. It cannot exceed 64 ASCII characters.

Name String No

The name of the VPN gateway.

The name can contain from 2 to 128 characters including a-z, A-Z, 0-9, underlines, and hyphens. The name must start with an English letter, but cannot start with http://  or https://.

Description String No

The description of the VPN gateway.

The description can contain from 2 to 256 characters. The description must start with English letters, but cannot start with http:// or https://.

Response parameters

Name Type Description
RequestId String The ID of the request.
VpnGatewayId String The ID of the VPN gateway.
VpcId String The ID of the VPC to which the VPN gateway belongs.
VSwitchId String The ID of the VSwitch to which the VPN gateway belongs.
InternetIp String The public IP address.
CreateTime Long The time when the VPN gateway was created.
EndTime Long The time when the VPN gateway expires.
Spec String The specification of the VPN gateway.
Name String The name of the VPN gateway.
Description String The description of the VPN gateway.
Status String The status of the VPN gateway. 
BusinessStatus String The business status of the VPN gateway.

Examples

Request example

https://vpc.aliyuncs.com/?Action=ModifyVpnGatewayAttribute
&RegionID=cn-beijing
&VpnGatewayId=vpn-bp1q8bgx4xnkm2ogj0fiu
&CommonParameters
Response example

  • XML format

    <? xml version="1.0" encoding="UTF-8" ? >
<ModifyVpnGatewayAttributeResponse>
    <Name>aaa</Name>
    <Status>active</Status>
    <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj0fiu</VpnGatewayId>
    <BusinessStatus>Normal</BusinessStatus>
    <Spec>5M</Spec>
    <CreateTime>1492753580000</CreateTime>
    <IntranetIp>172.16.104.158</IntranetIp>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B457</RequestId>
    <InternetIp>116.62.69.64</InternetIp>
    <EndTime>1495382400000</EndTime>
    <VSwitchId>vsw-bp1y9ovl1cu9ou4tvma0l</VSwitchId>
    <VpcId>vpc-bp1ub1yt9cvakoelj1y9c</VpcId>
</ModifyVpnGatewayAttributeResponse>

  • JSON format

    {
    "Name": "aaa", 
    "Status": "active", 
    "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj0fiu", 
    "BusinessStatus": "Normal", 
    "Spec": "5M", 
    "CreateTime": 1492753580000, 
    "IntranetIp": "172.16.104.158", 
    "RequestId": "BA56EAF8-E3A9-4BE6-8511-8F03512153E2", 
    "InternetIp": "116.62.69.64", 
    "EndTime": 1495382400000, 
    "VSwitchId": "vsw-bp1y9ovl1cu9ou4tvma0l", 
    "VpcId": "vpc-bp1ub1yt9cvakoelj1y9c"
}