NAT ゲートウェイ上の IP アドレスをクエリします。
今すぐお試しください
テスト
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 |
任意 |
リクエストを事前チェックのみ行うかどうかを指定します。有効値は次のとおりです。
|
false |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するために使用されるクライアントトークンです。 クライアント側で値を生成できますが、異なるリクエスト間で一意であることを保証する必要があります。トークンには ASCII 文字のみを使用でき、長さは 64 文字以内である必要があります。 説明
このパラメーターを設定しない場合、システムは自動的に RequestId を ClientToken として使用します。RequestId は各 API リクエストで異なる場合があります。 |
5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
| NatIpStatus |
string |
任意 |
IP アドレスのステータスです。有効値は次のとおりです。
|
Available |
| NextToken |
string |
任意 |
次のクエリに使用するトークンです。有効値は次のとおりです。
|
FFmyTO70tTpLG6I3FmYAXGKPd****f84eb48b699f0a4883 |
| MaxResults |
string |
任意 |
1 ページあたりに返されるエントリー数です。有効値:1 ~ 100。デフォルト値:20。 |
20 |
| NatIpName |
array |
任意 |
IP アドレスの名前です。N の有効値:1 ~ 20。 |
test |
|
string |
任意 |
IP アドレスの名前です。N の有効値:1 ~ 20。 |
test |
|
| NatIpIds |
array |
任意 |
IP アドレスの ID です。N の有効値:1 ~ 20。 |
vpcnatip-gw8a863sut1zijxh0**** |
|
string |
任意 |
IP アドレスの ID です。N の有効値:1 ~ 20。 |
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 |
次のクエリに使用するトークンです。有効値は次のとおりです。
|
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 |
| 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 |
例
成功レスポンス
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。