すべてのプロダクト
Search
ドキュメントセンター

NAT Gateway:ListNatIps

最終更新日:Apr 27, 2026

NAT ゲートウェイ上の IP アドレスをクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

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

最新のリージョンリストを取得するには、DescribeRegions 操作を呼び出してください。

eu-central-1

NatGatewayId

string

必須

NAT ゲートウェイの ID です。

ngw-gw8v16wgvtq26vh59****

NatIpCidr

string

任意

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

192.168.0.0/24

DryRun

boolean

任意

リクエストを事前チェックのみ行うかどうかを指定します。有効値は次のとおりです。

  • true:API リクエストをチェックします。IP アドレスはクエリされません。システムは必須パラメーター、リクエスト構文、および制限をチェックします。事前チェックに失敗した場合、対応するエラーメッセージが返されます。事前チェックに成功した場合、DryRunOperation エラーコードが返されます。

  • false (デフォルト):リクエストを送信します。事前チェックに成功した場合、2xx HTTP ステータスコードが返され、操作が実行されます。

false

ClientToken

string

任意

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

クライアント側で値を生成できますが、異なるリクエスト間で一意であることを保証する必要があります。トークンには ASCII 文字のみを使用でき、長さは 64 文字以内である必要があります。

説明

このパラメーターを設定しない場合、システムは自動的に RequestIdClientToken として使用します。RequestId は各 API リクエストで異なる場合があります。

5A2CFF0E-5718-45B5-9D4D-70B3FF3898

NatIpStatus

string

任意

IP アドレスのステータスです。有効値は次のとおりです。

  • Available

  • Deleting

  • Creating

Available

NextToken

string

任意

次のクエリに使用するトークンです。有効値は次のとおりです。

  • 初回クエリの場合、または次のクエリを送信しない場合は、このパラメーターを無視してください。

  • 次のクエリを送信する場合は、前回の呼び出しで返された NextToken の値を設定してください。

FFmyTO70tTpLG6I3FmYAXGKPd****f84eb48b699f0a4883

MaxResults

string

任意

1 ページあたりに返されるエントリー数です。有効値:1100。デフォルト値:20

20

NatIpName

array

任意

IP アドレスの名前です。N の有効値:120

test

string

任意

IP アドレスの名前です。N の有効値:120

test

NatIpIds

array

任意

IP アドレスの ID です。N の有効値:120

vpcnatip-gw8a863sut1zijxh0****

string

任意

IP アドレスの ID です。N の有効値:120

vpcnatcidr-gw8ov42ei6xh1jys2****

RegionId

string

必須

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

最新のリージョンリストを取得するには、DescribeRegions 操作を呼び出してください。

eu-central-1

IpOrigin

string

任意

NatIp のソースを記述するために使用されるフィールドの列挙です。Prefix は IPv4Prefix に属する NatIp を示します。cidr は分離された NatIp を示します。control はすべての NatIp を示します。

cidr

Ipv4Prefix

string

任意

IP プレフィックスのアドレス範囲です。

192.168.0.0/28

レスポンスフィールド

フィールド

説明

object

NextToken

string

次のクエリに使用するトークンです。有効値は次のとおりです。

  • NextToken の値が返されない場合、次のクエリを送信しないことを示します。

  • NextToken の値が返される場合、その値は次のクエリに使用するトークンを示します。

FFmyTO70tTpLG6I3FmYAXGKPd****

RequestId

string

リクエストの ID です。

7E78CEEA-BF8F-44D1-9DCD-D9141135B71E

TotalCount

string

返された IP アドレスの数です。

1

NatIps

array<object>

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

object

IsDefault

boolean

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

  • true:はい

  • false:いいえ

true

NatIp

string

IP アドレスです。

192.168.0.126

Ipv4Prefix

string

クエリされた NAT IP アドレスが属する IP プレフィックスのアドレス範囲です。

192.168.0.0/28

NatIpCidr

string

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

192.168.0.0/24

NatIpId

string

IP アドレスの ID です。

vpcnatip-gw8a863sut1zijxh0****

NatIpDescription

string

IP アドレスの説明です。

default

NatGatewayId

string

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

ngw-gw8v16wgvtq26vh59****

NatIpName

string

IP アドレスの名前です。

default

NatIpStatus

string

IP アドレスのステータスです。有効値は次のとおりです。

  • Available:利用可能

  • Deleted:削除済み

  • Deleting:削除中

  • Creating:作成中

  • Associated:SNAT または DNAT エントリで指定済み

  • Associating:SNAT または DNAT エントリで指定中

Available

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

404 InvalidRegionId.NotFound The specified RegionId does not exist in our records.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。