You need to enable JavaScript to run this app.
导航
VPN连接
  • 文档首页
    • /
  • VPN连接

CreateVpnGateway

最近更新时间：2024.04.18 17:23:56

首次发布时间：2022.04.28 07:17:14

我的收藏

调用CreateVpnGateway创建一个VPN网关。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必选示例值描述
ActionString是CreateVpnGateway要执行的操作，取值：CreateVpnGateway。
VersionString是2020-04-01API版本信息。
VpcIdString是vpc-5fn4gia8n2t****VPN网关所在VPC的ID。您可调用DescribeVpcs查询VPC的ID信息。
SubnetIdString是subnet-3thgqai7my4e8i****VPN网关使用子网的ID。您可调用DescribeSubnets查询子网的ID信息。

Bandwidth

Integer

是

5

VPN网关出云方向的带宽规格，单位：Mbps。取值：5、10、20、50、100、200、500、1000。

说明

1000Mbps带宽规格VPN网关为邀测功能，仅开通此规格的用户可使用，未开通此规格`Bandwidth`请避免传入“1000”。如有需要，请联系客户经理。

VpnGatewayName

String

否

VpnGateway

VPN网关的名称。

  • 以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。
  • 长度限制为1 ~ 128个字符。
  • 不填默认为VPN网关的ID。

Description

String

否

This is a sample description

VPN网关的描述信息。

  • 以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。
  • 长度限制为0 ~ 255个字符。
  • 不填默认为空字符串。

BillingType

Integer

否

1

VPN网关的计费类型。默认“1”。

  • 1（默认）：包年包月。
  • 2：按量计费（按固定配置）。

PeriodUnit

String

否

Month

包年包月类型VPN网关购买时长的单位，默认“Month”。

  • Month：月
  • Year：年

Period

Integer

否

1

包年包月类型VPN网关购买的时长，默认“1”。

  • 当PeriodUnit传入值为Month，Period取值范围：1~9、12、24、36。
  • 当PeriodUnit传入值为Year，Period取值范围：1～3。
ProjectNameString否Project_1VPN网关所属的项目。不填默认为default，即创建的资源属于default项目。您可调用ListProjects查询当前账号下项目的信息。

Tags.N.Key

String

否

Tags.1.Key=key1&Tags.2.Key=key2&Tags.3.Key=key3

VPN网关标签的标签键（Key）。

  • 参数 - N - 参数：表示标签键（Key）的序号，取值范围：1、2、3、……、49、50，且N应按照连续的从小到大的顺序。
  • 多个标签键（Key）之间用&分隔。
  • 不能以 volc:和sys:开头，包括任意大小写形式。volc:和sys:开头为系统预留标签，禁止创建。
  • 长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。

Tags.N.Value

String

否

Tags.1.Value=value1&Tags.2.Value=value2&Tags.3.Value=value3

VPN网关标签的标签值（Value）。

  • 参数 - N - 参数：表示标签值（Value）的序号，取值范围：1、2、3、……、49、50，且N应按照连续的从小到大的顺序。
  • 多个标签值（Value）之间用&分隔。
  • 长度取值范围为0～256字符，不填默认为空。
  • 允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。
  • 大小写敏感，不能以空格开头或结尾。

说明

传入Tags.N.Value则必须传入Tags.N.Key。

ClientToken

String

否

123e4567-e89b-12d3-a456-42665544****

客户端Token，用于保证请求幂等性。

  • 由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。
  • 仅支持ASCII字符，且不能超过64个字符。
  • 若不传入ClientToken，则此次API调用不进行幂等校验。

IpsecEnabled

Boolean

否

true

是否开启IPSec功能。

  • true（默认值）：开启

  • false：关闭

说明

IpsecEnabled和SslEnabled不可同时传入false。

SslEnabled

Boolean

否

false

是否开启SSL VPN功能。

  • true：开启

  • false（默认值）：关闭

说明

IpsecEnabled和SslEnabled不可同时传入false。

SslMaxConnections

Integer

否

10

SSL VPN规格的最大连接数，仅SslEnabled为true时可传入此参数。

  • 5（默认值）
  • 10
  • 20
  • 50
  • 100
  • 200

返回数据

名称类型
示例值
描述
RequestIdString2022032111142501022524314704AF****请求ID。
VpnGatewayIdStringvgw-12bfa2du7fojk17q7y1rk****新创建VPN网关的ID。
OrderIdStringOrder7078570823273845****新创建VPN网关的订单的ID。

请求示例

GET /?Action=CreateVpnGateway&Version=2020-04-01&VpnGatewayName=test&Description=test&VpcId=vpc-12bhs1ivo6p6o17q7y2x3****&SubnetId=subnet-2fewbgn7jbk0059gp67ap****&Bandwidth=5&BillingType=1&PeriodUnit=Month&Period=1 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata":{
        "RequestId":"2022032111142501022524314704AF****",
        "Action":"CreateVpnGateway",
        "Version":"2020-04-01",
        "Service":"vpn",
        "Region":"cn-beijing"
    },
    "Result":{
        "RequestId":"2022032111142501022524314704AF****",
        "OrderId":"Order7078570823273845****",
        "VpnGatewayId":"vgw-12bfa2du7fojk17q7y1rk****"
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode错误码错误信息描述
400InvalidName.MalformedThe specified name is malformed.Ensure the maximum length of name is 128.指定的名称格式不合法。名称长度不能超过128个字符。
400InvalidName.MalformedThe specified name is malformed.指定的名称格式不合法。请修复名称格式后重试。
400InvalidDescription.MalformedThe specified description is malformed.Ensure the maximum length of description is 255.指定的描述格式不合法。描述长度不能超过255个字符。
400InvalidDescription.MalformedThe specified description is malformed.指定的描述格式不合法。请修复描述格式后重试。
400InvalidSubnet.VpcMismatchThe specified subnet is not in the specified VPC.指定的子网不在指定的VPC中。
400InsufficientIpInSubnetThe specified subnet does not contain enough free private IP addresses to fulfill your request.指定子网下可用IP不足。
400InsufficientResource.VpnGatewayEipThe specified region does not have enough EIP resources for VPN gateway.VPN网关可用EIP资源不足。
400QuotaExceeded.EniENI number exceeded quota.已达到可创建网卡的数量上限。
400QuotaExceeded.SecurityGroupSecurity group number exceeded quota.当前账户已达到在一个地域下最多可创建安全组数量上限。
400InvalidVpnGatewayBandwidth.MalformedThe specified VPN gateway bandwidth is malformed.指定的VPN网关带宽不支持。
400InvalidBillingType.MalformedThe specified billing type is malformed.指定的计费类型不合法。
400InvalidMonthPeriod.MalformedThe specified monthly period is malformed. Monthly period only supports 1~9, 12, 24, 36.指定的预付费按月购买时长不合法。预付费按月购买时长只支持1~9, 12, 24, 36月。
400InvalidYearPeriod.MalformedThe specified yearly period is malformed. Yearly period only supports 1~3.指定的预付费按年购买时长不合法。预付费按年购买时长只支持1～3年。
400InvalidPeriodUnit.MalformedThe specified period unit is malformed. Pre billing period unit can only be Month or Year.指定的预付费类型时长单位不合法。预付费类型时长单位只能为月或年。
400OrderErrorFailed to create an order in one step.创建订单并支付失败。
400PreOrderErrorFailed to create pre order.创建配置单失败。
400QuotaExceeded.VPNGatewayYou've reached the limit on the number of VPN gateway per region that you can create.已达到当前账户在单一地域下可创建的VPN网关可创建数量上限。
400QuotaExceeded.VPNGatewayEachVPCYou've reached the limit on the number of VPN gateway per VPC that you can create.已达到当前账户在单一地域下可创建的VPN网关可创建数量上限。
400InsufficientResource.VpnGatewayThe specified region does not have enough resources for VPN gateway.VPN网关可用资源不足。
400InvalidTagKey.MalformedThe specified parameter tag key is invalid.标签键不合法。
400InvalidTagValue.MalformedThe specified parameter tag value is invalid.标签值不合法。
400LimitExceeded.TagsYou've reached the limit on the number of tags that you can operate at one time.已达到单次可操作标签数量的上限。
400InvalidTag.DisorderThe specified index order of tag is malformed.指定标签的索引顺序参数格式不合法。
400UnsupportedOperationThe request on the specified instance is denied due to the account balance and available vouchers are less than 100 yuan in total.因账户余额及可用代金券共不足100元，对于该实例的操作请求被拒绝。
400UnsupportedOperationThe request on the specified instance is denied due to the account in arrears status.因账户处于欠费状态，对于该实例的操作请求被拒绝。
400IdempotentParameterMismatchArguments on this idempotent request are inconsistent with arguments used in previous request(s).此幂等请求的参数与前一个请求中使用的参数不一致。
400InvalidParameter.ClientTokenMalformedThe specified parameter ClientToken is malformed.指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
400InvalidSslMaxConnections.MalformedThe specified SSL max connection of VPN Gateway is malformed.指定的VPN网关SSL最大连接数不合法。
400InvalidVpnEnabled.MalformedIpsecEnabled and SslEnabled can not be set to false at the same time.IPSec功能与SSL功能不能同时关闭。
403ForbiddenThe specified service is temporarily unavailable. Please try again later.指定的服务暂时不可用，请稍后重试。
404InvalidProject.NotFoundThe specified Project does not exist.指定的项目不存在。
404InvalidVpc.NotFoundThe specified VPC does not exist.指定的VPC不存在。
404InvalidSubnet.NotFoundThe specified subnet does not exist.指定的子网不存在。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.幂等请求处理中。