1. 接口描述
接口请求域名: vpc.api3.gsesgpucloud.com。
本接口(CreateVpnGateway)用于创建VPN网关。
默认接口请求频率限制:100次/秒。
接口更新时间:2020-11-10 16:12:20。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:CreateVpnGateway |
Version | 是 | 否 | String | 公共参数,本接口取值:2017-03-12 |
Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
VpcId | 是 | 否 | String | VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。 示例值: |
VpnGatewayName | 是 | 否 | String | VPN网关名称,最大长度不能超过60个字节。 示例值: |
InstanceChargeType | 否 | 否 | String | VPN网关计费模式,PREPAID:表示预付费,即包年包月,POSTPAID_BY_HOUR:表示后付费,即按量计费。默认:POSTPAID_BY_HOUR,如果指定预付费模式,参数InstanceChargePrepaid必填。 示例值: |
InternetMaxBandwidthOut | 是 | 否 | Uint64 | 公网带宽设置。可选带宽规格:5, 10, 20, 50, 100;单位:Mbps 示例值: |
InstanceChargePrepaid | 否 | 否 | InstanceChargePrepaid | 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。 示例值:查看 |
Zone | 否 | 否 | String | 可用区,如:ap-guangzhou-2。 示例值: |
Type | 否 | 否 | String | VPN网关类型。值“CCN”云联网类型VPN网关 示例值: |
IspType | 否 | 否 | String | 公网IP运营商 示例值: |
VsModelTag | 否 | 否 | String | VPN机型标签,eg:VS_VPN_INTEL 示例值: |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
VpnGateway | VpnGateway | VPN网关对象 示例值:查看 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue.VpnConnCidrConflict | 目的网段和当前VPN通道的CIDR冲突。 |
InvalidVpcId.Malformed | 无效的VPC,VPC实例ID不合法。 |
InvalidVpcId.NotFound | 无效的VPC,VPC资源不存在。 |
InvalidParameterValue | 参数值不合法。 |