Help & DocumentationAPIsVirtual Private CloudVPC API 2017APIs for VPN GatewayAPIs for IPsec VPNRenew VPN Gateway

Renew VPN Gateway

Last updated: 2019-11-29 19:13:11

Contents：

1. API Description

This API (RenewVpn) is used to renew the VPN.
Domain for API request: vpc.api.qcloud.com

2. Input Parameters

The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. For more information, refer to Common Request Parameters.

Parameter Name Required Type Description
vpcId Yes string VPC ID or unified ID (unified ID is recommended). For example: vpc-aa3z6vxo. Can be queried via the API DescribeVpcEx.
vpnGwId Yes string VPN gateway ID to be modified, which can be vpnGwId or unVpnGwId. unVpnGwId is recommended. For example: pngw-nhg87nmg. Can be queried via the API DescribeVpnGw.
period Yes Int Number of month you want to renew (up to 36 months)

3. Output Parameters

Parameter Name Type Description
code Int Error code, 0: Succeeded; other values: Failed
message String Error message

4. Error Codes

This API does not have service error codes. For common error codes, see VPC Error Codes.

5. Example

Input

  https://domain/v2/index.php?Action=RenewVpn
  &<Common request parameters>
  &vpcId=gz_vpc_1111
    &period=1
    &vpnGwId=1

Output

{
    "code" : 0,
    "message" : "ok",
}