调用CreateVpnGateway创建一个VPN网关。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateVpnGateway | 要执行的操作,取值:CreateVpnGateway。 |
Version | String | 是 | 2020-04-01 | API版本信息。 |
VpcId | String | 是 | vpc-5fn4gia8n2t**** | VPN网关所在VPC的ID。您可调用DescribeVpcs查询VPC的ID信息。 说明 VPN连接暂不支持共享VPN,此处请不要传入共享VPC的ID。 |
SubnetId | String | 是 | 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网关的名称。
|
Description | String | 否 | This is a sample description | VPN网关的描述信息。
|
BillingType | Integer | 否 | 1 | VPN网关的计费类型。默认“1”。
|
PeriodUnit | String | 否 | Month | 包年包月类型VPN网关购买时长的单位,默认“Month”。
|
Period | Integer | 否 | 1 | 包年包月类型VPN网关购买的时长,默认“1”。
|
ProjectName | String | 否 | Project_1 | VPN网关所属的项目。不填默认为default ,即创建的资源属于default项目。您可调用ListProjects查询当前账号下项目的信息。 |
Tags.N.Key | String | 否 | Tags.1.Key=key1&Tags.2.Key=key2&Tags.3.Key=key3 | VPN网关标签的标签键(Key)。
|
Tags.N.Value | String | 否 | Tags.1.Value=value1&Tags.2.Value=value2&Tags.3.Value=value3 | VPN网关标签的标签值(Value)。
说明 传入 |
ClientToken | String | 否 | 123e4567-e89b-12d3-a456-42665544**** | 客户端Token,用于保证请求幂等性。
|
IpsecEnabled | Boolean | 否 | true | 是否开启IPSec功能。
说明
|
SslEnabled | Boolean | 否 | false | 是否开启SSL VPN功能。
说明
|
SslMaxConnections | Integer | 否 | 10 | SSL VPN规格的最大连接数,仅
|
Asn | Integer | 否 | 64512 | VPN网关的ASN。
说明 VPN连接BGP功能为邀测功能,仅开通后可使用,如需试用请联系客户经理。未开通请不要传入此参数。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 2022032111142501022524314704AF**** | 请求ID。 |
VpnGatewayId | String | vgw-12bfa2du7fojk17q7y1rk**** | 新创建VPN网关的ID。 |
OrderId | String | Order7078570823273845**** | 新创建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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidName.Malformed | The specified name is malformed.Ensure the maximum length of name is 128. | 指定的名称格式不合法。名称长度不能超过128个字符。 |
400 | InvalidName.Malformed | The specified name is malformed. | 指定的名称格式不合法。请修复名称格式后重试。 |
400 | InvalidDescription.Malformed | The specified description is malformed.Ensure the maximum length of description is 255. | 指定的描述格式不合法。描述长度不能超过255个字符。 |
400 | InvalidDescription.Malformed | The specified description is malformed. | 指定的描述格式不合法。请修复描述格式后重试。 |
400 | InvalidSubnet.VpcMismatch | The specified subnet is not in the specified VPC. | 指定的子网不在指定的VPC中。 |
400 | InsufficientIpInSubnet | The specified subnet does not contain enough free private IP addresses to fulfill your request. | 指定子网下可用IP不足。 |
400 | InsufficientResource.VpnGatewayEip | The specified region does not have enough EIP resources for VPN gateway. | VPN网关可用EIP资源不足。 |
400 | QuotaExceeded.Eni | ENI number exceeded quota. | 已达到可创建网卡的数量上限。 |
400 | QuotaExceeded.SecurityGroup | Security group number exceeded quota. | 当前账户已达到在一个地域下最多可创建安全组数量上限。 |
400 | InvalidVpnGatewayBandwidth.Malformed | The specified VPN gateway bandwidth is malformed. | 指定的VPN网关带宽不支持。 |
400 | InvalidBillingType.Malformed | The specified billing type is malformed. | 指定的计费类型不合法。 |
400 | InvalidMonthPeriod.Malformed | The specified monthly period is malformed. Monthly period only supports 1~9, 12, 24, 36. | 指定的预付费按月购买时长不合法。预付费按月购买时长只支持1~9, 12, 24, 36月。 |
400 | InvalidYearPeriod.Malformed | The specified yearly period is malformed. Yearly period only supports 1~3. | 指定的预付费按年购买时长不合法。预付费按年购买时长只支持1~3年。 |
400 | InvalidPeriodUnit.Malformed | The specified period unit is malformed. Pre billing period unit can only be Month or Year. | 指定的预付费类型时长单位不合法。预付费类型时长单位只能为月或年。 |
400 | OrderError | Failed to create an order in one step. | 创建订单并支付失败。 |
400 | PreOrderError | Failed to create pre order. | 创建配置单失败。 |
400 | QuotaExceeded.VPNGateway | You've reached the limit on the number of VPN gateway per region that you can create. | 已达到当前账户在单一地域下可创建的VPN网关可创建数量上限。 |
400 | QuotaExceeded.VPNGatewayEachVPC | You've reached the limit on the number of VPN gateway per VPC that you can create. | 已达到当前账户在单一地域下可创建的VPN网关可创建数量上限。 |
400 | InsufficientResource.VpnGateway | The specified region does not have enough resources for VPN gateway. | VPN网关可用资源不足。 |
400 | InvalidTagKey.Malformed | The specified parameter tag key is invalid. | 标签键不合法。 |
400 | InvalidTagValue.Malformed | The specified parameter tag value is invalid. | 标签值不合法。 |
400 | LimitExceeded.Tags | You've reached the limit on the number of tags that you can operate at one time. | 已达到单次可操作标签数量的上限。 |
400 | InvalidTag.Disorder | The specified index order of tag is malformed. | 指定标签的索引顺序参数格式不合法。 |
400 | UnsupportedOperation | The request on the specified instance is denied due to the account balance and available vouchers are less than 100 yuan in total. | 因账户余额及可用代金券共不足100元,对于该实例的操作请求被拒绝。 |
400 | UnsupportedOperation | The request on the specified instance is denied due to the account in arrears status. | 因账户处于欠费状态,对于该实例的操作请求被拒绝。 |
400 | IdempotentParameterMismatch | Arguments on this idempotent request are inconsistent with arguments used in previous request(s). | 此幂等请求的参数与前一个请求中使用的参数不一致。 |
400 | InvalidParameter.ClientTokenMalformed | The specified parameter ClientToken is malformed. | 指定的参数ClientToken格式不合法,长度不能超过64个ASCII字符。 |
400 | InvalidSslMaxConnections.Malformed | The specified SSL max connection of VPN Gateway is malformed. | 指定的VPN网关SSL最大连接数不合法。 |
400 | InvalidVpnEnabled.Malformed | IpsecEnabled and SslEnabled can not be set to false at the same time. | IPSec功能与SSL功能不能同时关闭。 |
400 | InvalidVpnGateway.InvalidASN | The VPN Gateway ASN is invalid and it should be in the range of 64512-65534 or 4200000000-4294967294. | 指定的ASN不合法。ASN应该在64512-65534、4200000000-4294967294范围内。 |
403 | Forbidden | The specified service is temporarily unavailable. Please try again later. | 指定的服务暂时不可用,请稍后重试。 |
403 | Forbidden.SharedVpc | You are not authorized to perform operations on the specified shared VPC. | 无权限对指定共享私有网络进行操作。 |
403 | Forbidden.VpnBgpPermissionNotGranted | The specified account is not granted VPN BGP permission. | 当前账号未开通VPN支持BGP权限。 |
404 | InvalidProject.NotFound | The specified Project does not exist. | 指定的项目不存在。 |
404 | InvalidVpc.NotFound | The specified VPC does not exist. | 指定的VPC不存在。 |
404 | InvalidSubnet.NotFound | The specified subnet does not exist. | 指定的子网不存在。 |
404 | InvalidZoneId.NotFound | The specified zone does not exist. | 指定的可用区不存在。 |
412 | IdempotentProcessing | The request uses the same client token as a previous one that is still in process. | 幂等请求处理中。 |