Note：
This is a legacy API which has been hidden and will no longer be updated. We recommend using the new VPC API 3.0 which is standardized and faster.
This API (CreateVpn) is used to purchase VPN gateway.
Domain for API request: vpc.api.qcloud.com
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 |
|---|---|---|---|
| name | Yes | string | IPsec VPN gateway name. Up to 60 characters. |
| vpcId | Yes | string | VPC ID or unified ID (unified ID is recommened). It can be queried via the API DescribeVpcEx. |
| period | Yes | Int | Number of month you want to purchase (up to 36) |
| bandwidth | Yes | Int | Bandwidth, supported values: 5, 10, 20, 50, 100 (in Mb). |
| Parameter Name | Type | Description |
|---|---|---|
| code | Int | Error code, 0: Succeeded, other values: Failed. |
| message | String | Error message. |
| dealIds | Array | The generated order number. You can call DescribeVpnGw API to query VPN details |
The API does not have a business error code. For common error codes, see VPC Error Codes for details.
Input
https://domain/v2/index.php?Action=CreateVpn &<Common request parameters> &vpcId=gz_vpc_1111 &period=1 &name=test &bandwidth=5
Output
{
"code" : 0,
"message" : "ok",
"data":
｛
"dealIds":[
121
]
｝
}
Was this page helpful?