調用CreateIpv4Gateway介面建立IPv4網關。
介面說明
- CreateIpv4Gateway 介面屬於非同步介面，即系統返回一個執行個體 ID，但該 IPv4 網關尚未建立成功，系統背景建立任務仍在進行。您可以調用 GetIpv4GatewayAttribute 查詢 IPv4 網關的建立狀態：
當 IPv4 網關處於 Creating 狀態時，表示 IPv4 網關正在建立中。
當 IPv4 網關處於 Created 狀態時，表示 IPv4 網關建立完成。
CreateIpv4Gateway 介面不支援在同一個 VPC 下並發建立 IPv4 網關。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Ipv4GatewayName |
string |
否 |
建立的 IPv4 網關的名稱。 名稱長度為 1～128 個字元，不能以 |
ipv4 |
| Ipv4GatewayDescription |
string |
否 |
建立的 IPv4 網關的描述資訊。 描述長度為 1～256 個字元，不能以 |
test |
| VpcId |
string |
是 |
建立的 IPv4 網關所在 VPC 的 ID。 一個 VPC 僅支援建立一個 IPv4 網關。 |
vpc-5tss06uvoyps5xoya**** |
| DryRun |
boolean |
否 |
是否只預檢此次請求。取值：
|
false |
| ClientToken |
string |
否 |
用戶端 Token，用於保證請求的等冪性。 從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。 |
123e4567-e89b-12d3-a456-426655440000 |
| RegionId |
string |
是 |
建立 IPv4 網關的地區 ID。 您可以通過調用 DescribeRegions 介面擷取地區 ID。 |
ap-southeast-6 |
| ResourceGroupId |
string |
否 |
資源群組 ID。 |
rg-acfmxazb4ph6aiy**** |
| Tag |
array<object> |
否 |
資源的標籤。 |
|
|
object |
否 |
標籤。 |
||
| Key |
string |
否 |
資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入Null 字元串。 一個標籤鍵最多支援 128 個字元，不能以 |
FinanceDept |
| Value |
string |
否 |
資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值，可以輸入Null 字元串。 最多支援 128 個字元，不能以 |
FinanceJoshua |
| RegionId |
string |
是 |
建立 IPv4 網關的地區 ID。 您可以通過調用 DescribeRegions 介面擷取地區 ID。 |
ap-southeast-6 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
建立的 IPv4 網關的執行個體 ID。 |
||
| Ipv4GatewayId |
string |
建立的 IPv4 網關的執行個體 ID。 |
ipv4gw-5tsnc6s4ogsedtp3k**** |
| ResourceGroupId |
string |
資源群組 ID。 |
rg-acfmxazb4ph6aiy**** |
| RequestId |
string |
請求 ID。 |
F282742B-1BBB-5F63-A3AF-E92EC575A1A6 |
樣本
正常返回樣本
JSON格式
{
"Ipv4GatewayId": "ipv4gw-5tsnc6s4ogsedtp3k****",
"ResourceGroupId": "rg-acfmxazb4ph6aiy****",
"RequestId": "F282742B-1BBB-5F63-A3AF-E92EC575A1A6"
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | OperationDenied.ExistDirectEip | The operation is not allowed because of existing direct eip. | 不允許建立ipv4網關，因為存在直通eip |
| 400 | UnsupportedRegion | The feature of ipv4Gateway is not supported in the region. | 該地區不支援ipv4網關 |
| 400 | Forbidden.OperateShareResource | You cannot operate shared resources. | 來自共用的資源不允許操作。 |
| 400 | OperationDenied.SubnetRouteV1Exist | The operation is not allowed because of existing subnetRouteV1. | 操作不允許，該VPC下子網路由不符合規格 |
| 400 | OperationDenied.NormalNatExist | The operation is not allowed because of existing normalNat. | 操作不允許，該VPC下存在普通型NAT Gateway |
| 400 | OperationDenied.VpcExistIpv4Gateway | An IPv4 gateway already exists in the VPC. | 不允許建立IPv4網關，因為VPC已經存在IPv4網關 |
| 400 | UnsupportedFeature.Ipv4Gateway | The feature of ipv4Gateway is not supported for [%s]. | 建立ipv4網關失敗，因為不支援ipv4網關特性 |
| 400 | OperationDenied.VpnExist | The operation is not allowed because of existing vpn. | 不允許建立IPv4網關，因為VPC已經存在VPN網關 |
| 400 | OperationDenied.DirectEipExist | The operation is not allowed because of existing directEip. | 操作不允許，該VPC下存在直通EIP或增強型NAT Gateway |
| 400 | OperationFailed.GetNfvServiceList | The operation is failed because of get nfv serviceList failed. | 操作不允許，擷取nfv服務列表失敗 |
| 400 | IncorrectStatus.Vpc | The status of %s [%s] is incorrect. | 當前執行個體狀態非穩態 |
| 400 | OperationFailed.VpcNotExist | The operation is failed because of vpc is not found. | 操作失敗，未找到vpc |
| 400 | IllegalParam.ResourceGroupId | Invalid ResourceGroupld value. | 指定的資源群組非法或不存在 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。