edit-icon download-icon

ModifyVpnGatewayAttribute

Last Updated: Apr 12, 2018

Description

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.
Token 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.

For more information, see How to ensure idempotence.

Name String No

The name of the VPN gateway.

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

The description of the VPN gateway.

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

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 creation time of the VPN gateway.
EndTime Long The expiration time of the VPN gateway.
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.

Error codes

See VPC API Error Center.

Examples

Request example

  1. https://vpc.aliyuncs.com/?Action=ModifyVpnGatewayAttribute
  2. &RegionID=cn-beijing
  3. &VpnGatewayId=vpn-bp1q8bgx4xnkm2ogj0fiu
  4. &<CommonParameters>

Response example

XML format

  1. <ModifyVpnGatewayAttributeResponse>
  2. <Name>aaa</Name>
  3. <Status>active</Status>
  4. <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj0fiu</VpnGatewayId>
  5. <BusinessStatus>Normal</BusinessStatus>
  6. <Spec>5M</Spec>
  7. <CreateTime>1492753580000</CreateTime>
  8. <IntranetIp>172.16.104.158</IntranetIp>
  9. <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B457</RequestId>
  10. <InternetIp>116.62.69.64</InternetIp>
  11. <EndTime>1495382400000</EndTime>
  12. <VSwitchId>vsw-bp1y9ovl1cu9ou4tvma0l</VSwitchId>
  13. <VpcId>vpc-bp1ub1yt9cvakoelj1y9c</VpcId>
  14. </ModifyVpnGatewayAttributeResponse>

JSON format

  1. {
  2. "Name":"aaa",
  3. "Status":"active",
  4. "VpnGatewayId":"vpn-bp1q8bgx4xnkm2ogj0fiu",
  5. "BusinessStatus":"Normal",
  6. "Spec":"5M",
  7. "CreateTime":1492753580000,
  8. "IntranetIp":"172.16.104.158",
  9. "RequestId":"BA56EAF8-E3A9-4BE6-8511-8F03512153E2",
  10. "InternetIp":"116.62.69.64",
  11. "EndTime":1495382400000,
  12. "VSwitchId":"vsw-bp1y9ovl1cu9ou4tvma0l",
  13. "VpcId":"vpc-bp1ub1yt9cvakoelj1y9c"
  14. }
Thank you! We've received your feedback.