租户端 网络 私有网络（VPC） 历史版本（V2接口）

购买VPN网关

最近更新时间: 2024-06-12 15:06:00

1. 接口描述

本接口(CreateVpn)用于购买VPN网关。 接口请求域名：vpc.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，见公共请求参数页面。其中，此接口的Action字段为CreateVpn。

参数名称 必选 类型 描述
name 是 string IPsec VPN网关名称，可任意命名，但不得超过60个字符。
vpcId 是 string 网络ID或者统一ID，建议使用统一ID,可通过 DescribeVpcEx 接口查询。
period 是 Int 查询的购买时长，单位月，最大36个月。
bandwidth 是 Int 带宽，只支持：5、10、20、50、100，单位Mb。

3. 输出参数

参数名称 类型 描述
code Int 错误码，0: 成功，其他值: 失败。
message String 错误信息。
dealIds Array 生成的订单号，可以用订单号调用 查询VPN网关列表 查询VPN信息

4. 错误码表

该接口没有业务错误码，公共错误码详见公共错误码 。

5. 示例

输入

  https://domain/v2/index.php?Action=CreateVpn
  &<公共请求参数>
  &vpcId=gz_vpc_1111
    &period=1
    &name=test
    &bandwidth=5

输出

{
    "code": 0,
    "message": "ok",
    "data": {
        "dealIds": [
            121
        ]
    }
}