创建P2C VPN网关
功能介绍
创建P2C VPN网关。
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/p2c-vpn-gateways
名称 |
类型 |
是否必选 |
描述 |
---|---|---|---|
project_id |
String |
是 |
项目ID,可以通过获取项目ID获取项目ID。 |
请求消息
- 请求参数
表2 请求参数 名称
类型
是否必选
描述
p2c_vpn_gateway
CreateP2cVgwRequestBodyContent
object
是
p2c_vpn_gateway对象。
表3 CreateP2cVgwRequestBodyContent 名称
类型
必选
描述
name
String
否
- 功能说明:P2C VPN网关名称。
- 取值范围:1-64个字符,支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。
vpc_id
String
是
- 功能说明:P2C VPN网关使用的VPC的ID。
- 约束:36位UUID。
connect_subnet
String
是
- 功能说明:P2C VPN网关使用的VPC子网ID。
- 约束:36位UUID。
flavor
String
否
availability_zone_ids
Array of String
否
- 功能说明:部署P2C VPN网关的可用区。不填时自动为P2C VPN网关选择可用区。
- 约束:如果P2C VPN网关支持两个及以上的可用区时,必须填写两个可用区;支持一个可用区时填写一个;无支持可用区时不能创建VPN网关。
eip
CreateRequestEip object
是
- 功能说明:P2C VPN网关使用的EIP。
tags
Array of Tag object
否
- 功能说明:标签列表。
- 约束:最多填写20个。
表4 CreateRequestEip 名称
类型
必选
描述
id
String
否
- 功能说明:EIP的ID。
- 取值范围:36位UUID。
- 约束:当使用已有EIP时填写,当新创建EIP时不填。
可以通过查询弹性公网IP列表查看EIP的ID。
type
String
否
charge_mode
String
否
bandwidth_size
Integer
否
- 功能说明:EIP的带宽大小,单位:Mbit/s。每个region能够提供的EIP最大带宽不同,EIP的最大带宽受限于EIP服务,可以使用工单来提高帐户下的EIP的最大带宽。
- 取值范围:1-300,具体取值请参考弹性公网服务创建EIP资料。
- 约束:当新创建EIP场景且不绑定共享带宽时需要填写,否则不填。
bandwidth_name
String
否
- 功能说明:EIP的带宽名称。
- 取值范围:1-64个字符,支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(点)。
- 约束:当新创建EIP场景时需要填写,否则不填。
- 默认值:当新创建EIP场景时,不填此字段会自动生成格式为p2c-vpngw-bandwidth-****的EIP带宽名称。例如:p2c-vpngw-bandwidth-e5b4。
表5 Tag 名称
类型
必选
描述
key
String
是
- 功能说明:标签的键。
- 取值范围:1-128个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。
value
String
是
- 功能说明:标签的值。
- 取值范围:0-255个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。
- 请求样例
POST https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways { "p2c_vpn_gateway": { "name": "p2c-vpngw-0003", "vpc_id": "d9d85143-e1e1-427a-9994-d8b8fd9ebe3f", "availability_zone_ids": ["cn-north-7a", "cn-north-7b"], "connect_subnet": "2d1da07b-861d-447d-8233-1aff4d767825", "eip": { "bandwidth_name": "", "bandwidth_size": 10, "type": "5_bgp" }, "flavor": "Professional1" } }
响应消息
- 响应参数
返回状态码为 201: successful operation。
表6 响应Body参数列表 名称
类型
描述
p2c_vpn_gateway
ResponseP2cVgw object
P2C VPN网关。
request_id
String
请求ID。
表7 ResponseP2cVgw 名称
类型
描述
id
String
- 功能说明:P2C VPN网关ID。
- 格式:36位UUID。
- 响应样例
{ "p2c_vpn_gateway": { "id": "10d176c7-aed8-4766-9180-a47e536c64d0" }, "request_id": "b19ba5a0be8f7b7f664b14596f8f35db" }
状态码
请参见状态码。