华为云计算 云知识 创建虚拟网关CreateVirtualGateway
创建虚拟网关CreateVirtualGateway

 

功能介绍

创建虚拟网关

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

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

ent erp rise_project_id

String

实例所属企业项目ID

最小长度:36

最大长度:36

tags

Array of Tag objects

标签信息

数组长度:0 - 10

表5 Tag

参数

是否必选

参数类型

描述

key

String

标签键,最大长度36个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。

最小长度:0

最大长度:36

value

String

标签值,最大长度43个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。

最小长度:0

最大长度:43

响应参数

状态码: 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

tags

Array of Tag objects

标签信息

数组长度:0 - 10

表8 Tag

参数

参数类型

描述

key

String

标签键,最大长度36个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。

最小长度:0

最大长度:36

value

String

标签值,最大长度43个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。

最小长度:0

最大长度:43

请求示例

创建一个虚拟网关,设置本地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",
    "type" : "default",
    "status" : "ACTIVE",
    "admin_state_up" : true,
    "bgp_asn" : 64512,
    "local_ep_group" : [ "192.168.1.0/24" ],
    "enterprise_project_id" : "0"
  },
  "request_id" : "765f7aaf8f2edd0e719de564ef72e2de"
}

状态码

状态码

描述

201

CREATED

错误码

请参见错误码

 

上一篇:重置云手机ResetCloudPhone 下一篇:第二范式(2NF)的理解