華為云計算 云知識 創(chuàng)建私網(wǎng)NAT網(wǎng)關(guān)CreatePrivateNat
創(chuàng)建私網(wǎng)NAT網(wǎng)關(guān)CreatePrivateNat

 

接口說明

創(chuàng)建 私網(wǎng)NAT網(wǎng)關(guān) 實例。

URL
POST  https://nat.cn-north-4.myhuaweicloud.com/v3/{project_id}/private-nat/gateways 
請求參數(shù)
名稱 類型 IN 必選 描述
X-Auth-Token
 
string header

用戶Token。 用戶Token也就是調(diào)用獲取用戶Token獲取請求認(rèn)證接口的響應(yīng)值,該接口是唯一不需要認(rèn)證的接口。 請求響應(yīng)成功后在響應(yīng)消息頭中包含的“X-Subject-Token”的值即為Token值。

project_id
 
string path

項目的ID。

Body參數(shù)
名稱 類型 必選 描述
gateway
 
CreatePrivateNatOption object

創(chuàng)建私網(wǎng) NAT網(wǎng)關(guān) 實例的請求體。

參數(shù):
gateway
名稱 類型 必選 描述
name
 
string

私網(wǎng)NAT網(wǎng)關(guān)實例的名字。 私網(wǎng)NAT網(wǎng)關(guān)實例的名字僅支持?jǐn)?shù)字、字母、_(下劃線)、-(中劃線)、中文。

description
 
string

私網(wǎng)NAT網(wǎng)關(guān)實例的描述。

spec
 
string

私網(wǎng)NAT網(wǎng)關(guān)實例的規(guī)格。 取值為: "Small":小型 "Medium":中型 "Large":大型 "Extra-large":超大型

downlink_vpcs
 
Array of DownlinkVpcOption objects

私網(wǎng)NAT網(wǎng)關(guān)實例所屬的VPC實例。

tags
 
Array of PrivateTag objects

標(biāo)簽列表

enterprise_project_id
 
string

企業(yè)項目ID 創(chuàng)建私網(wǎng)NAT網(wǎng)關(guān)實例時,關(guān)聯(lián)的企業(yè)項目ID。 關(guān)于企業(yè)項目ID的獲取及企業(yè)項目特性的詳細(xì)信息,請參考《企業(yè)管理用戶指南》。

參數(shù):
gateway.tags
名稱 類型 必選 描述
key
 
string

標(biāo)簽key值。

value
 
string

標(biāo)簽value。

返回參數(shù)
返回碼: 201

創(chuàng)建私網(wǎng)NAT網(wǎng)關(guān)實例成功。

名稱 類型 必選 描述
gateway
 
PrivateNat object

私網(wǎng)NAT網(wǎng)關(guān)實例的響應(yīng)體。

request_id
 
string

請求ID。

201 gateway
名稱 類型 必選 描述
id
 
string

私網(wǎng)NAT網(wǎng)關(guān)實例的ID。

project_id
 
string

項目的ID。

name
 
string

私網(wǎng)NAT網(wǎng)關(guān)實例的名字。

description
 
string

私網(wǎng)NAT網(wǎng)關(guān)實例的描述。

spec
 
string

私網(wǎng)NAT網(wǎng)關(guān)實例的規(guī)格。 取值為: "Small":小型 "Medium":中型 "Large":大型 "Extra-large":超大型

status
 
string

私網(wǎng)NAT網(wǎng)關(guān)實例的狀態(tài)。 取值為: "ACTIVE":正常運行 "FROZEN":凍結(jié)

created_at
 
string

私網(wǎng)NAT網(wǎng)關(guān)實例的創(chuàng)建時間,遵循UTC時間,格式是yyyy-mm-ddThh:mm:ssZ。

updated_at
 
string

私網(wǎng)NAT網(wǎng)關(guān)實例的更新時間,遵循UTC時間,格式是yyyy-mm-ddThh:mm:ssZ。

downlink_vpcs
 
Array of DownlinkVpc objects

私網(wǎng)NAT網(wǎng)關(guān)實例所屬的VPC實例。

tags
 
Array of PrivateTag objects

標(biāo)簽列表。

enterprise_project_id
 
string

企業(yè)項目ID。 創(chuàng)建私網(wǎng)NAT網(wǎng)關(guān)實例時,關(guān)聯(lián)的企業(yè)項目ID。

201 gateway.tags
名稱 類型 必選 描述
key
 
string

標(biāo)簽key值。

value
 
string

標(biāo)簽value。

請求示例
示例 1

創(chuàng)建私網(wǎng)NAT網(wǎng)關(guān)

 
"POST https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/gateways"
 
{ "gateway": { "name": "private-nat-gateway-name", "description": "private-nat-gateway-description", "spec": "Small", "enterprise_project_id": "2759da7b-8015-404c-ae0a-a389007b0e2a", "downlink_vpcs": [ { "virsubnet_id": "373979ee-f4f0-46c5-80e3-0fbf72646b70" } ], "tags": [ { "key": "key1", "value": "value1" } ] } }
返回示例
返回碼:201

創(chuàng)建私網(wǎng)NAT網(wǎng)關(guān)實例成功。

示例 1
 
{
"request_id": "9882046a9b96f1405472e36d797e33dc",
"gateway": {
"id": "14338426-6afe-4019-996b-3a9525296e11",
"name": "private-nat-gateway-name",
"description": "private-nat-gateway-description",
"spec": "Small",
"project_id": "70505c941b9b4dfd82fd351932328a2f",
"enterprise_project_id": "2759da7b-8015-404c-ae0a-a389007b0e2a",
"status": "ACTIVE",
"created_at": "2019-04-22T08:47:13",
"updated_at": "2019-04-22T08:47:13",
"tags": [
{
"key": "key1",
"value": "value1"
}
],
"downlink_vpcs": [
{
"vpc_id": "3cb66d44-9f75-4237-bfff-e37b14d23ad2",
"virsubnet_id": "373979ee-f4f0-46c5-80e3-0fbf72646b70"
}
]
}
}
SDK
點擊 NAT網(wǎng)關(guān) (NAT) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認(rèn)證方式等在SDK文檔中對應(yīng)語言類型的【使用】目錄下。
錯誤碼
請參考 錯誤碼說明。