文档首页/云专线 DC/API参考 (联盟区域) /API/虚拟网关/创建虚拟网关
更新时间：2026-01-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建虚拟网关

功能介绍

创建虚拟网关

调用方法

请参见如何调用API。

URI

POST /v3/{project_id}/dcaas/virtual-gateways

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度：0

最大长度：10240

表3 请求Body参数

参数

是否必选

参数类型

描述

virtual_gateway

否

CreateVirtualGateway object

创建虚拟网关对象参数

表4 CreateVirtualGateway

参数

是否必选

参数类型

描述

vpc_id

是

String

虚拟网关接入的VPC的ID

name

否

String

虚拟网关名字

最小长度：0

最大长度：64

description

否

String

虚拟网关的描述信息

最小长度：0

最大长度：128

local_ep_group

是

Array of strings

虚拟网关到访问云上服务IPv4子网列表，通常是vpc的cidrs

local_ep_group_ipv6

否

Array of strings

预留字段用于虚拟网关到访问云上服务IPv6子网列表，通常是vpc的cidrs

bgp_asn

否

Integer

虚拟网关本地的BGP自治域号(asn)

最小值：1

最大值：4294967295

enterprise_project_id

否

String

实例所属企业项目ID

最小长度：36

最大长度：36

tags

否

Array of Tag objects

标签信息

数组长度：0 - 10

表5 Tag

参数

是否必选

参数类型

描述

key

是

String

标签键。
  • 不能为空。
  • 对于同一资源标签键的取值唯一。
  • 最大长度36个unicode字符。
  • 仅允许使用数字、字母、中划线“-”、下划线“_”、符号“@”、点“.”。

value

否

String

标签值。
  • 可以为空。
  • 最大长度43个unicode字符。
  • 仅允许使用数字、字母、中划线“-”、下划线“_”、符号“@”、点“.”。

响应参数

状态码： 201

表6 响应Body参数

参数

参数类型

描述

virtual_gateway

VirtualGateway object

虚拟网关对象

request_id

String

操作请求ID

表7 VirtualGateway

参数

参数类型

描述

id

String

虚拟网关的ID

vpc_id

String

虚拟网关接入的VPC的ID

tenant_id

String

实例所属项目ID。

最小长度：32

最大长度：32

name

String

虚拟网关的名字

最小长度：0

最大长度：64

description

String

虚拟网关的描述

最小长度：0

最大长度：128

type

String

虚拟网关类型：default

缺省值：default

local_ep_group

Array of strings

虚拟网关到访问云上服务IPv4子网列表，通常是vpc的cidrs

local_ep_group_ipv6

Array of strings

预留字段用于虚拟网关到访问云上服务IPv6子网列表，通常是vpc的cidrs

admin_state_up

Boolean

管理状态：true或false

缺省值：true

status

String

操作状态，合法值是：ACTIVE，DOWN，BUILD，ERROR，PENDING_CREATE，PENDING_UPDATE，PENDING_DELETE

bgp_asn

Integer

虚拟网关本地的BGP自治域号(asn)

最小值：1

最大值：4294967295

enterprise_project_id

String

实例所属企业项目ID

最小长度：36

最大长度：36

device_id

String

归属的设备ID

redundant_device_id

String

归属的冗余设备ID

public_border_group

String

归属的可用区对应的边界组(public border group)，标识是否homezone局点。

tags

Array of Tag objects

标签信息

数组长度：0 - 10

表8 Tag

参数

参数类型

描述

key

String

标签键。
  • 不能为空。
  • 对于同一资源标签键的取值唯一。
  • 最大长度36个unicode字符。
  • 仅允许使用数字、字母、中划线“-”、下划线“_”、符号“@”、点“.”。

value

String

标签值。
  • 可以为空。
  • 最大长度43个unicode字符。
  • 仅允许使用数字、字母、中划线“-”、下划线“_”、符号“@”、点“.”。

请求示例

  • 创建一个接入虚拟私有云的虚拟网关，设置本地BGP ASN为64512，虚拟网关访问云专服务IPv4子网列表为192.168.1.0/24。 
    POST https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways

{
  "virtual_gateway" : {
    "name" : "vgw-c7b22",
    "description" : "",
    "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
    "bgp_asn" : 64512,
    "local_ep_group" : [ "192.168.1.0/24" ]
  }
}

响应示例

状态码： 201

Created

  • 成功创建接入虚拟私有云的虚拟网关。 
    {
  "virtual_gateway" : {
    "id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
    "name" : "vgw-c7b22",
    "description" : "",
    "tenant_id" : "0605768a3300d5762f82c01180692873",
    "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
    "tags": [],
    "device_id" : "26.151.63.100",
    "redundant_device_id" : "26.152.128.20",
    "type" : "default",
    "status" : "ACTIVE",
    "admin_state_up" : true,
    "bgp_asn" : 64512,
    "local_ep_group" : [ "192.168.1.0/24" ],
    "enterprise_project_id" : "0",
    "public_border_group" : "center"
  }
}

状态码

状态码

描述

201

Created

错误码

请参见错误码。

父主题：虚拟网关