指定されたNATゲートウェイのCIDRブロックを照会します。

デバッグ

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

リクエストパラメーター

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

照会するVirtual Private Cloud (VPC) NATゲートウェイのリージョンID。

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

NatGatewayId String 必須 ngw-gw8v16wgvtq26vh59 ****

照会するVPC NATゲートウェイのID。

NatIpCidr String 任意 172.16.0.0/24

照会するNATゲートウェイのCIDRブロック。

DryRun Boolean いいえ false

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

  • true: APIリクエストを確認します。 APIリクエストが事前チェックに合格した場合、NATゲートウェイのCIDRブロックは照会されません。 システムは、AccessKeyペアが有効かどうか、Resource Access Management (RAM) ユーザーが許可されているかどうか、および必要なパラメーターが設定されているかどうかを確認します。 リクエストが事前チェックに合格しなかった場合、対応するエラーメッセージが返されます。 確認が成功した場合、DryRunOperation と返されます。
  • false: APIリクエストを送信します。 リクエストが事前チェックに合格すると、2xx HTTPステータスコードが返され、NATゲートウェイのCIDRブロックが照会されます。 デフォルト値です。
ClientToken String 任意 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

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

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

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

照会するCIDRブロックのステータス。 値をAvailableに設定します。

NextToken String 任意 caeba0bbb2be03f84eb48b699f0a4883

次のクエリに使用されるトークン。 必要に応じて値を設定します。

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

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

操作 String 必須 ListNatIpCidrs

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

NatIpCidrName.N String 任意 cidrname

照会するCIDRブロックの名前。 Nの有効値: 1〜20。

NatIpCidrs.N String 任意 172.16.0.0/24

照会するNATゲートウェイのCIDRブロック。 Nの有効値: 1〜20。

レスポンスパラメーター

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

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

  • NextTokenの値が返されない場合、次のクエリは送信されないことを示します。
  • NextTokenの値が返された場合、値は次のクエリで使用されるトークンを示します。
RequestId String 7479A224-4A28-4895-9604-11F48BCE6A88

リクエストの ID です。

TotalCount String 1

返されるCIDRブロックの数。

NatIpCidrs NatIpCidrの配列

NATゲートウェイのCIDRブロック。

CreationTime String 2021-06-28T20:50Z

CIDRブロックが作成された時刻。

NatIpCidrId String vpcnatcidr-gw8ov42ei6xh1jys2 ****

NATゲートウェイのCIDRブロックのID。

IsDefault ブール 真実

CIDRブロックがNATゲートウェイのデフォルトCIDRブロックであるかどうかを示します。 有効な値：

  • true: CIDRブロックは、NATゲートウェイのデフォルトのCIDRブロックです。
  • false: CIDRブロックはNATゲートウェイのデフォルトのCIDRブロックではありません。
NatIpCidrStatus String Available

NATゲートウェイのCIDRブロックのステータス。 Availableが返された場合、CIDRブロックが使用可能であることを示します。

NatIpCidrName String 名前

NATゲートウェイのCIDRブロックの名前。

NatIpCidr String 172.16.0.0/24

NATゲートウェイのCIDRブロック。

NatGatewayId String ngw-gw8v16wgvtq26vh59 ****

VPC NATゲートウェイのID。

NatIpCidrDescription String test

NATゲートウェイのCIDRブロックの説明。

例

リクエストの例

http(s)://[Endpoint]/?RegionId=eu-central-1
&NatGatewayId=ngw-gw8v16wgvtq26vh59 ****
&NatIpCidr=172.16.0.0/24
&DryRun=false
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&NatIpCidrStatus=Available
&NextToken=caeba0bbb2be03f84eb48b699f0a4883
&MaxResults=20
&NatIpCidrName=["cidrname"]
&NatIpCidrs=["172.16.0.0/24"]
&アクション=ListNatIpCidrs
&共通リクエストパラメータ

レスポンスの例

XML 形式 

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

<ListNatIpCidrsResponse>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <RequestId>7479A224-4A28-4895-9604-11F48BCE6A88</RequestId>
    <TotalCount> 1 </ TotalCount>
    <NatIpCidrs>
        <CreationTime>2021-06-28T20:50Z</CreationTime>
        <NatIpCidrId>vpcnatcidr-gw8ov42ei6xh1jys2 ****</NatIpCidrId>
        <IsDefault>true</IsDefault>
        <NatIpCidrStatus> 利用可能 </NatIpCidrStatus>
        <NatIpCidrName> デフォルト </NatIpCidrName>
        <NatIpCidr>172.16.0.0/24</NatIpCidr>
        <NatGatewayId>ngw-gw8v16wgvtq26vh59 ****</NatGatewayId>
        <NatIpCidrDescription> デフォルト </NatIpCidrDescription>
    </NatIpCidrs>
</ListNatIpCidrsResponse>

JSON 形式 

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

{
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883" 、
  "RequestId" : "7479A224-4A28-4895-9604-11F48BCE6A88" 、
  "TotalCount" : "1" 、
  "NatIpCidrs" : [ {
    "CreationTime" : "2021-06-28T20:50Z" 、
    "NatIpCidrId" : "vpcnatcidr-gw8ov42ei6xh1jys2 ****" 、
    "IsDefault" : true、
    "NatIpCidrStatus" : "Available" 、
    "NatIpCidrName" : "デフォルト" 、
    "NatIpCidr" : "172.16.0.0/24" 、
    "NatGatewayId" : "ngw-gw8v16wgvtq26vh59 ****" 、
    "NatIpCidrDescription" : "デフォルト"
  } ]
}

エラーコード

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

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