IPv4 ゲートウェイを作成します。
操作説明
-
CreateIpv4Gateway は非同期操作です。リクエストを送信すると、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。IPv4 ゲートウェイのステータスを確認するには、GetIpv4GatewayAttribute 操作を呼び出してください。
IPv4 ゲートウェイのステータスが Creating の場合、IPv4 ゲートウェイは作成中です。
IPv4 ゲートウェイのステータスが Created の場合、IPv4 ゲートウェイは作成済みです。
-
指定された時間内に、同一の仮想プライベートクラウド (VPC) 内で CreateIpv4Gateway 操作を繰り返し呼び出して IPv4 ゲートウェイを作成することはできません。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Ipv4GatewayName |
string |
任意 |
IPv4 ゲートウェイの名前。 名前は 1~128 文字で指定し、 |
ipv4 |
| Ipv4GatewayDescription |
string |
任意 |
IPv4 ゲートウェイの説明。 説明は 1~256 文字で指定し、 |
test |
| VpcId |
string |
必須 |
IPv4 ゲートウェイを作成する VPC の ID。 VPC 内に作成できる IPv4 ゲートウェイは 1 つだけです。 |
vpc-5tss06uvoyps5xoya**** |
| DryRun |
boolean |
任意 |
ドライランを実行するかどうかを指定します。有効値:
|
false |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するために使用されるクライアントトークン。 この値はクライアント側で生成できますが、異なるリクエスト間で一意であることを保証する必要があります。ClientToken には ASCII 文字のみを使用できます。 説明
このパラメーターを設定しない場合、システムは ClientToken を RequestId の値に設定します。各 API リクエストの RequestId は異なります。 |
123e4567-e89b-12d3-a456-426655440000 |
| RegionId |
string |
必須 |
IPv4 ゲートウェイを作成するリージョンの ID。 最新のリージョンリストを取得するには、DescribeRegions 操作を呼び出してください。 |
ap-southeast-6 |
| ResourceGroupId |
string |
任意 |
リソースグループの ID。 |
rg-acfmxazb4ph6aiy**** |
| Tag |
array<object> |
任意 |
リソースに付与するタグ。 |
|
|
object |
任意 |
|||
| Key |
string |
任意 |
リソースに追加するタグ N のキー。最大 20 個のタグキーを指定できます。タグキーは空文字列にできません。 タグキーの長さは最大 128 文字です。 |
FinanceDept |
| Value |
string |
任意 |
リソースに追加するタグ N の値。最大 20 個のタグ値を指定できます。タグ値は空文字列にできます。 タグ値の長さは最大 128 文字です。 |
FinanceJoshua |
| RegionId |
string |
必須 |
IPv4 ゲートウェイを作成するリージョンの ID。 最新のリージョンリストを取得するには、DescribeRegions 操作を呼び出してください。 |
ap-southeast-6 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| Ipv4GatewayId |
string |
IPv4 ゲートウェイの ID。 |
ipv4gw-5tsnc6s4ogsedtp3k**** |
| ResourceGroupId |
string |
リソースグループの ID。 |
rg-acfmxazb4ph6aiy**** |
| RequestId |
string |
リクエストの ID。 |
F282742B-1BBB-5F63-A3AF-E92EC575A1A6 |
例
成功レスポンス
JSONJSON
{
"Ipv4GatewayId": "ipv4gw-5tsnc6s4ogsedtp3k****",
"ResourceGroupId": "rg-acfmxazb4ph6aiy****",
"RequestId": "F282742B-1BBB-5F63-A3AF-E92EC575A1A6"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | OperationDenied.ExistDirectEip | The operation is not allowed because of existing direct eip. | |
| 400 | UnsupportedRegion | The feature of ipv4Gateway is not supported in the region. | |
| 400 | Forbidden.OperateShareResource | You cannot operate shared resources. | |
| 400 | OperationDenied.SubnetRouteV1Exist | The operation is not allowed because of existing subnetRouteV1. | |
| 400 | OperationDenied.NormalNatExist | The operation is not allowed because of existing normalNat. | |
| 400 | OperationDenied.VpcExistIpv4Gateway | An IPv4 gateway already exists in the VPC. | |
| 400 | UnsupportedFeature.Ipv4Gateway | The feature of ipv4Gateway is not supported for [%s]. | |
| 400 | OperationDenied.VpnExist | The operation is not allowed because of existing vpn. | |
| 400 | OperationDenied.DirectEipExist | The operation is not allowed because of existing directEip. | |
| 400 | OperationFailed.GetNfvServiceList | The operation is failed because of get nfv serviceList failed. | |
| 400 | IncorrectStatus.Vpc | The status of %s [%s] is incorrect. | |
| 400 | OperationFailed.VpcNotExist | The operation is failed because of vpc is not found. | |
| 400 | IllegalParam.ResourceGroupId | Invalid ResourceGroupld value. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。