NATゲートウェイのIPアドレスを照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須／任意 例: 説明　
RegionId String 必須 eu-central-1

NATゲートウェイがデプロイされているリージョンのID。

DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

NatGatewayId String 必須 ngw-gw8v16wgvtq26vh59 ****

NAT ゲートウェイの ID 。

NatIpCidr String 任意 192.168.0.0/24

IPアドレスが属するCIDRブロック。

DryRun Boolean いいえ false

リクエストのみを事前チェックするかどうかを指定します。 有効な値：

  • true: APIリクエストを確認します。 IPアドレスは照会されません。 システムは、必要なパラメーター、要求構文、および制限をチェックします。 リクエストが事前チェックに合格しなかった場合、対応するエラーメッセージが返されます。 リクエストが事前チェックに合格した場合、DryRunOperationエラーコードが返されます。
  • false (デフォルト): リクエストを送信します。 リクエストが事前チェックに合格すると、2xx HTTPステータスコードが返され、操作が実行されます。
ClientToken String 任意 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

リクエストのべき等性を保証するために使用されるクライアントトークン。

クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 トークンにはASCII文字のみを使用でき、長さは64文字を超えることはできません。

説明 このパラメーターを設定しない場合、システムは自動的にRequestIdをClientTokenとして使用します。 RequestIdは、APIリクエストごとに異なる場合があります。
NatIpStatus String 任意 使用可能

IPアドレスのステータス。 有効な値：

  • 利用可能
  • 削除中
  • 作成中
NextToken String 任意 FFmyTO70tTpLG6I3FmYAXGKPd **** f84eb48b699f0a4883

次のクエリに使用されるトークン。 有効な値：

  • これが最初のクエリである場合、または次のクエリを送信しない場合は、このパラメーターを無視します。
  • 次のクエリを送信する場合は、前回の呼び出しから返されたNextTokenの値に値を設定します。
MaxResults String 任意 20

各ページで返されるエントリ数。 有効な値: 1〜100。 デフォルト値: 20

操作 String 必須 ListNatIps

実行する操作です。 値をListNatIpsに設定します。

NatIpName.N String 任意 test

IPアドレスの名前。 Nの有効値: 1〜20。

NatIpIds.N String 任意 vpcnatcidr-gw8ov42ei6xh1jys2 ****

IPアドレスのID。 Nの有効値: 1〜20。

レスポンスパラメーター

項目 データ型 例: 説明　
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd ****

次のクエリに使用されるトークン。 有効な値：

  • NextTokenの値が返されない場合、次のクエリは送信されないことを示します。
  • NextTokenの値が返された場合、値は次のクエリで使用されるトークンを示します。
RequestId String 7E78CEEA-BF8F-44D1-9DCD-D9141135B71E

リクエストの ID です。

TotalCount String 1

返されるIPアドレスの数。

NatIps NatIpの配列

NATゲートウェイのIPアドレスのリスト。

IsDefault ブール 真実

IPアドレスがNATゲートウェイのデフォルトIPアドレスであるかどうかを示します。 有効な値：

  • true: はい
  • false: いいえ
ナティップ String 192.168.0.126

IP アドレス。

NatIpCidr String 192.168.0.0/24

IPアドレスが属するCIDRブロック。

NatIpId String vpcnatip-gw8a863sut1zijxh0 ****

IPアドレスのID。

NatIpDescription String default

IPアドレスの説明。

NatGatewayId String ngw-gw8v16wgvtq26vh59 ****

IPアドレスが割り当てられているVPC (Virtual Private Cloud) NATゲートウェイのID。

NatIpName String default

IPアドレスの名前。

NatIpStatus String Available

IPアドレスのステータス。 有効な値：

  • 利用可能: 利用可能
  • 削除済み: 削除済み
  • 削除: 削除
  • Creating: creating
  • Associated: SNATまたはDNATエントリで指定
  • Associating: SNATまたはDNATエントリで指定中

例

リクエストの例

http(s)://[Endpoint]/?RegionId=eu-central-1
&NatGatewayId=ngw-gw8v16wgvtq26vh59 ****
&NatIpCidr=192.168.0.0/24
&DryRun=false
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&NatIpStatus=Available
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd **** f84eb48b699f0a4883
&MaxResults=20
&NatIpName=["test"]
&NatIpIds=["vpcnatcidr-gw8ov42ei6xh1jys2 ****"]
&アクション=ListNatIps
&共通リクエストパラメータ

レスポンスの例

XML 形式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListNatIpsResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd ****</NextToken>
    <RequestId>7E78CEEA-BF8F-44D1-9DCD-D9141135B71E</RequestId>
    <TotalCount> 1 </ TotalCount>
    <NatIps>
        <IsDefault>true</IsDefault>
        <NatIp>192.168.0.126</NatIp>
        <NatIpCidr>192.168.0.0/24</NatIpCidr>
        <NatIpId>vpcnatip-gw8a863sut1zijxh0 ****</NatIpId>
        <NatIpDescription> デフォルト </NatIpDescription>
        <NatGatewayId>ngw-gw8v16wgvtq26vh59 ****</NatGatewayId>
        <NatIpName> デフォルト </NatIpName>
        <NatIpStatus> 利用可能 </NatIpStatus>
    </NatIps>
</ListNatIpsResponse>

JSON 形式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd ****" 、
  "RequestId" : "7E78CEEA-BF8F-44D1-9DCD-D9141135B71E" 、
  "TotalCount" : "1" 、
  "NatIps" : [ {
    "IsDefault" : true、
    "NatIp" : "192.168.0.126" 、
    "NatIpCidr" : "192.168.0.0/24" 、
    "NatIpId" : "vpcnatip-gw8a863sut1zijxh0 ****" 、
    "NatIpDescription" : "デフォルト" 、
    "NatGatewayId" : "ngw-gw8v16wgvtq26vh59 ****" 、
    "NatIpName" : "デフォルト" 、
    "NatIpStatus" : "Available"
  } ]
}

エラーコード

HttpCode エラーコード エラーメッセージ 説明　
404 InvalidRegionId.NotFound 指定された RegionId はレコードに存在しません。 指定されたリージョンIDが存在しない場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。