創建私網NAT網關
更新時間 2024-09-14 17:15:31
最近更新時間: 2024-09-14 17:15:31
分享文章
接口功能介紹
創建私網NAT
接口約束
無
接口是否審批
否
URI
POST /v4/privatenat/create
Content-Type
application/json
路徑參數
無
Query參數
無
請求頭header參數
無
請求體body參數
參數 是否必填 參數類型 說明 示例 下級對象 regionID 是 String 區域 id 79fa97e3-c48b-xxxx-9f46-6a13d8163678 projectID 是 String 項目ID 2256c561639d4ed9b9fb9009398914ad vpcID 是 String 需要創建 私網NAT 網關的 VPC 的ID vpc-bp1xxxu subnetID 是 String 需要創建私網NBAT網關的Subnet的ID subnet-xxxxx spec 是 String 規格, small 表示小型, medium 表示中型, large 表示大型, xlarge 表示超大型 small name 是 String 支持拉丁字母、中文、數字,下劃線,連字符,中文 / 英文字母開頭,不能以 http: / https: 開頭,長度 2 - 32 acl11 description 否 String 支持拉丁字母、中文、數字, 特殊字符:!@#$%^&\*()\_\-+= <>?:\"{}\|,.\/;'[\]·@#¥%……&\*() ——\-+={} | 《》?:“”【】、;‘',。、,不能以 http: / https: 開頭,長度 0 - 128 acl clientToken 是 String 客戶端存根,用于保證訂單冪等性, 長度 1 - 64 79fa97e3-c48b-xxxx-9f46-6a13d8163678 cycleType 是 String 訂購類型:month / year month cycleCount 是 Integer 訂購時長 3 azName 是 String 可用區名稱 az1 autoRenew 否 Boolean 是否自動續約 true billMode 是 Integer 付費模式:2 - 按需,1 - 保周期 2 payVoucherPrice 否 String 代金券金額,支持到小數點后兩位 1
響應參數
| 響應參數 | 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800 為成功,900 為失敗 | 800 | ||
| message | String | statusCode 為 900 時的錯誤信息; statusCode 為 800 時為 success, 英文 | success | ||
| description | String | statusCode 為 900 時的錯誤信息; statusCode 為 800 時為成功, 中文 | 成功 | ||
| errorCode | String | statusCode 為 900 時為業務細分錯誤碼,三段式:product.module.code; statusCode 為 800 時為 SUCCESS | SUCCESS | ||
| returnObj | Object | object |
| 表 returnObj | 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| masterOrderID | String | 訂單 id。 | 55d531d7bf2d47658897c42ffb918423 | ||
| masterOrderNO | String | 訂單編號, 可以為 null。 | 20221021191602644224 | ||
| masterResourceStatus | String | 資源狀態: started(啟用) / renewed(續訂) / refunded(退訂) / destroyed(銷毀) / failed(失敗) / starting(正在啟用) / changed(變配)/ expired(過期)/ unknown(未知) | started | ||
| masterResourceID | String | 可以為 null。 | d48cace2da7b4c81b4c0444768a04608 | ||
| regionID | String | 可用區 id。 | 81f7728662dd11ec810800155d307d5b | ||
| natGatewayID | String | nat 網關 ID | natgw-xxx |
枚舉參數
無
請求頭header示例
無
請求url示例
無
請求體body示例
{
"name":"提測測試流程",
"description":"開始提測了",
"vpcID":"vpc-xxxxx",
"subnetID":"subnet-xxxxx",
"spec":"small",
"regionId":"81f7728662dd11ec810800155d307d5b",
"clientToken":"xxxxxx",
"cycleType":"month",
"cycleCount":1,
"azName":"az1"
}
響應示例
{
"statusCode":800,
"message":"success",
"description":"成功",
"errorCode":"SUCCESS",
"returnObj":{
"masterOrderID":"ee508bcc586211ed961bacde48001122",
"masterOrderNO":null,
"masterResourceID":"d48cace2da7b4c81b4c0444768a04608",
"masterResourceStatus":"started",
"regionID":"81f7728662dd11ec810800155d307d5b",
"natGatewayID":"natgw-xxxx"
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
錯誤碼
請參考錯誤碼