NAT IPアドレスを作成します。
使用上の注意
CreateNatIpは非同期操作です。 リクエストを行うと、リクエストのIDが返されますが、NAT IPアドレスは作成されません。 システムはバックグラウンドでNAT IPアドレスを作成します。 ListNatIps操作を呼び出して、NAT IPアドレスのステータスを照会できます。
- NAT IPアドレスが作成中の状態の場合、NAT IPアドレスは作成中です。 この場合、NAT IPアドレスのみを照会できますが、その他の操作は実行できません。
- NAT IPアドレスが使用可能状態の場合、NAT IPアドレスが作成されます。
CreateNatIp操作を繰り返し呼び出して、指定された期間内にNAT IPアドレスを作成することはできません。
デバッグ
リクエストパラメーター
項目 | データ型 | 必須/任意 | 例: | 説明 |
---|---|---|---|---|
RegionId | String | 必須 | eu-central-1 |
作成するNAT IPアドレスが属するNATゲートウェイのリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。 |
NatGatewayId | String | 必須 | ngw-gw8v16wgvtq26vh59 **** |
NAT IPアドレスを作成するVPC (Virtual Private Cloud) NATゲートウェイのID。 |
NatIpName | String | 必須 | newnatip |
NAT IPアドレスの名前。 名前は2 ~ 128文字で、英数字、ピリオド (.) 、アンダースコア (_) 、ハイフン (-) を使用できます。 先頭は文字である必要があります。 先頭文字列を |
NatIpDescription | String | 必須 | test |
NAT IPアドレスの説明。 説明の長さは 2~256 文字である必要があります。 名前は英字で始まる必要があります。先頭文字列は |
DryRun | Boolean | いいえ | false |
このリクエストのみを事前チェックするかどうかを指定します。 有効な値:
|
ClientToken | String | 任意 | 5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 クライアントトークンにはASCII文字のみを含めることができます。 説明 このパラメーターを設定しない場合、ClientTokenはRequestIdの値に設定されます。 各APIリクエストのRequestIdの値は異なる場合があります。
|
NatIpCidr | String | 任意 | 192.168.0.0/24 |
NAT IPアドレスが属するCIDRブロック。 |
NatIpCidrId | String | 任意 | vpcnatip-gw8y7q3cpk3fggs87 **** |
NAT IPアドレスが属するCIDRブロックのID。 |
ナティップ | String | 任意 | 192.168.0.34 |
作成するNAT IPアドレス。 IPアドレスを指定しない場合、システムは指定されたCIDRブロックからランダムなIPアドレスを選択します。 |
操作 | String | 必須 | CreateNatIp |
実行する操作です。 値をCreateNatIpに設定します。 |
レスポンスパラメーター
項目 | データ型 | 例: | 説明 |
---|---|---|---|
ナティップ | String | 192.168.0.34 |
NAT IPアドレス。 |
RequestId | String | E9AD97A0-5338-43F8-8A80-5E274CCBA11B |
リクエストの ID です。 |
NatIpId | String | vpcnatip-gw8y7q3cpk3fggs8 **** |
NAT IPアドレスのID。 |
例
リクエストの例
http(s)://[Endpoint]/?RegionId=eu-central-1
&NatGatewayId=ngw-gw8v16wgvtq26vh59 ****
&NatIpName=newnatip
&NatIpDescription=テスト
&DryRun=false
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&NatIpCidr=192.168.0.0/24
&NatIpCidrId=vpcnatip-gw8y7q3cpk3fggs87 ****
&NatIp=192.168.0.34
&アクション=CreateNatIp
&共通リクエストパラメータ
正常に処理された場合のレスポンス例
XML
形式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateNatIpResponse>
<NatIp>192.168.0.34</NatIp>
<RequestId>E9AD97A0-5338-43F8-8A80-5E274CCBA11B</RequestId>
<NatIpId>vpcnatip-gw8y7q3cpk3fggs8 ****</NatIpId>
</CreateNatIpResponse>
JSON
形式
HTTP/1.1 200 OK
Content-Type:application/json
{
"NatIp" : "192.168.0.34" 、
"RequestId" : "E9AD97A0-5338-43F8-8A80-5E274CCBA11B" 、
"NatIpId" : "vpcnatip-gw8y7q3cpk3fggs8 ****"
}
エラーコード
HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
---|---|---|---|
404 | InvalidRegionId.NotFound | 指定された RegionId はレコードに存在しません。 | 指定されたリージョンIDが存在しない場合に返されるエラーメッセージ。 |
エラーコードリストについては、「API エラーセンター」をご参照ください。