華為云計(jì)算 云知識(shí) 創(chuàng)建虛擬網(wǎng)關(guān)CreateVirtualGateway
創(chuàng)建虛擬網(wǎng)關(guān)CreateVirtualGateway

 

功能介紹

創(chuàng)建虛擬網(wǎng)關(guān)

調(diào)試

您可以在API Explorer中調(diào)試該接口,支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。

URI

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

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

project_id

String

租戶項(xiàng)目ID

請(qǐng)求參數(shù)

表2 請(qǐng)求Header參數(shù)

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

X-Auth-Token

String

用戶Token。 獲取Token ,請(qǐng)參考《 統(tǒng)一身份認(rèn)證 服務(wù)API參考》的“獲取用戶Token”章節(jié)。請(qǐng)求響應(yīng)成功后在響應(yīng)消息頭中包含的“X-Subject-Token”的值即為T(mén)oken值。

最小長(zhǎng)度:0

最大長(zhǎng)度:10240

表3 請(qǐng)求Body參數(shù)

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

virtual_gateway

CreateVirtualGateway object

創(chuàng)建虛擬網(wǎng)關(guān)對(duì)象參數(shù)

表4 CreateVirtualGateway

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

vpc_id

String

虛擬網(wǎng)關(guān)接入的VPC的ID

name

String

虛擬網(wǎng)關(guān)名字

最小長(zhǎng)度:0

最大長(zhǎng)度:64

description

String

虛擬網(wǎng)關(guān)的描述信息

最小長(zhǎng)度:0

最大長(zhǎng)度:128

local_ep_group

Array of strings

虛擬網(wǎng)關(guān)到訪問(wèn)云上服務(wù)IPv4子網(wǎng)列表,通常是vpc的cidrs

local_ep_group_ipv6

Array of strings

預(yù)留字段用于虛擬網(wǎng)關(guān)到訪問(wèn)云上服務(wù)IPv6子網(wǎng)列表,通常是vpc的cidrs

bgp_asn

Integer

虛擬網(wǎng)關(guān)本地的BGP自冶域號(hào)(asn)

最小值:1

最大值:4294967295

enterprise_project_id

String

實(shí)例所屬企業(yè)項(xiàng)目ID

最小長(zhǎng)度:36

最大長(zhǎng)度:36

tags

Array of Tag objects

標(biāo)簽信息

數(shù)組長(zhǎng)度:0 - 10

表5 Tag

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

key

String

標(biāo)簽鍵,最大長(zhǎng)度36個(gè)unicode字符,格式為大小寫(xiě)字母,數(shù)字,中劃線“-”,下劃線“_”,中文。

最小長(zhǎng)度:0

最大長(zhǎng)度:36

value

String

標(biāo)簽值,最大長(zhǎng)度43個(gè)unicode字符,格式為大小寫(xiě)字母,數(shù)字,中劃線“-”,下劃線“_”,點(diǎn)“.”,中文。

最小長(zhǎng)度:0

最大長(zhǎng)度:43

響應(yīng)參數(shù)

狀態(tài)碼: 201

表6 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類(lèi)型

描述

virtual_gateway

VirtualGateway object

虛擬網(wǎng)關(guān)對(duì)象

request_id

String

操作請(qǐng)求ID

表7 VirtualGateway

參數(shù)

參數(shù)類(lèi)型

描述

id

String

虛擬網(wǎng)關(guān)的ID

vpc_id

String

虛擬網(wǎng)關(guān)接入的VPC的ID

tenant_id

String

實(shí)例所屬項(xiàng)目ID。

最小長(zhǎng)度:32

最大長(zhǎng)度:32

name

String

虛擬網(wǎng)關(guān)的名字

最小長(zhǎng)度:0

最大長(zhǎng)度:64

description

String

虛擬網(wǎng)關(guān)的描述

最小長(zhǎng)度:0

最大長(zhǎng)度:128

type

String

虛擬網(wǎng)關(guān)類(lèi)型:default

缺省值:default

local_ep_group

Array of strings

虛擬網(wǎng)關(guān)到訪問(wèn)云上服務(wù)IPv4子網(wǎng)列表,通常是vpc的cidrs

local_ep_group_ipv6

Array of strings

預(yù)留字段用于虛擬網(wǎng)關(guān)到訪問(wèn)云上服務(wù)IPv6子網(wǎng)列表,通常是vpc的cidrs

admin_state_up

Boolean

管理狀態(tài):true或false

缺省值:true

status

String

操作狀態(tài),合法值是:ACTIVE,DOWN,BUILD,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE

bgp_asn

Integer

虛擬網(wǎng)關(guān)本地的BGP自冶域號(hào)(asn)

最小值:1

最大值:4294967295

enterprise_project_id

String

實(shí)例所屬企業(yè)項(xiàng)目ID

最小長(zhǎng)度:36

最大長(zhǎng)度:36

tags

Array of Tag objects

標(biāo)簽信息

數(shù)組長(zhǎng)度:0 - 10

表8 Tag

參數(shù)

參數(shù)類(lèi)型

描述

key

String

標(biāo)簽鍵,最大長(zhǎng)度36個(gè)unicode字符,格式為大小寫(xiě)字母,數(shù)字,中劃線“-”,下劃線“_”,中文。

最小長(zhǎng)度:0

最大長(zhǎng)度:36

value

String

標(biāo)簽值,最大長(zhǎng)度43個(gè)unicode字符,格式為大小寫(xiě)字母,數(shù)字,中劃線“-”,下劃線“_”,點(diǎn)“.”,中文。

最小長(zhǎng)度:0

最大長(zhǎng)度:43

請(qǐng)求示例

創(chuàng)建一個(gè)虛擬網(wǎng)關(guān),設(shè)置本地BGP ASN為64512,虛擬網(wǎng)關(guān)訪問(wèn)云專(zhuān)服務(wù)IPv4子網(wǎng)列表為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" ]
  }
}

響應(yīng)示例

狀態(tài)碼: 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"
}

狀態(tài)碼

狀態(tài)碼

描述

201

CREATED

錯(cuò)誤碼

請(qǐng)參見(jiàn)錯(cuò)誤碼。