ListNatIpCidrs - NAT Gateway - Alibaba Cloud ドキュメントセンター

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

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	クエリ対象の Virtual Private Cloud (VPC) NAT ゲートウェイが配置されているリージョン ID です。最新のリージョン一覧は、DescribeRegions 操作を呼び出して確認できます。	eu-central-1
NatGatewayId	string	必須	クエリ対象の VPC NAT ゲートウェイの ID です。	ngw-gw8v16wgvtq26vh59****
NatIpCidr	string	任意	クエリ対象の NAT ゲートウェイの CIDR ブロックです。	172.16.0.0/24
DryRun	boolean	任意	このリクエストを事前チェックのみ行うかどうかを指定します。有効な値は次のとおりです。 true：API リクエストをチェックします。API リクエストが事前チェックに合格しても、NAT ゲートウェイの CIDR ブロックはクエリされません。システムは、AccessKey ペアが有効かどうか、Resource Access Management (RAM) ユーザーに権限が付与されているかどうか、必須パラメーターが設定されているかどうかをチェックします。リクエストが事前チェックに失敗した場合は、対応するエラーメッセージが返されます。チェックが成功した場合は、DryRunOperation エラーコードが返されます。 false：API リクエストを送信します。リクエストが事前チェックに合格すると、2xx HTTP ステータスコードが返され、NAT ゲートウェイの CIDR ブロックがクエリされます。これがデフォルト値です。	false
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークンです。この値はクライアント側で生成できますが、異なるリクエスト間で一意であることを保証する必要があります。トークンには ASCII 文字のみを使用でき、長さは 64 文字を超えてはなりません。説明このパラメーターを設定しない場合、システムは自動的に RequestId を ClientToken として使用します。RequestId は各 API リクエストごとに異なる場合があります。	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
NatIpCidrStatus	string	任意	クエリ対象の CIDR ブロックのステータスです。Available を指定してください。	Available
NextToken	string	任意	次のクエリに使用するトークンです。必要に応じて値を設定してください。初回クエリの場合、または次のクエリを送信しない場合は、このパラメーターを無視してください。次のクエリを送信する場合は、前回の呼び出しから返された NextToken の値を設定してください。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	string	任意	1 ページあたりに返されるエントリ数です。有効な値：1 ～ 100。デフォルト値：20。	20
NatIpCidrName	array	任意	クエリ対象の CIDR ブロックの名前です。N の有効な値：1 ～ 20。	test
	string	任意	クエリ対象の CIDR ブロックの名前です。N の有効な値：1 ～ 20。	cidrname
NatIpCidrs	array	任意	クエリ対象の NAT ゲートウェイの CIDR ブロックです。N の有効な値：1 ～ 20。	172.16.0.0/24
	string	任意	クエリ対象の NAT ゲートウェイの CIDR ブロックです。N の有効な値：1 ～ 20。	172.16.0.0/24
RegionId	string	必須	クエリ対象の Virtual Private Cloud (VPC) NAT ゲートウェイが配置されているリージョン ID です。最新のリージョン一覧は、DescribeRegions 操作を呼び出して確認できます。	eu-central-1

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	次のクエリに使用するトークンです。有効な値は次のとおりです。 NextToken の値が返されない場合、次のクエリを送信しないことを示します。 NextToken の値が返される場合、その値は次のクエリに使用するトークンを示します。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	リクエストの ID です。	7479A224-4A28-4895-9604-11F48BCE6A88
TotalCount	string	返された CIDR ブロックの数です。	1
NatIpCidrs	array<object>	NAT ゲートウェイの CIDR ブロックです。
	object
CreationTime	string	CIDR ブロックが作成された時刻です。	2021-06-28T20:50Z
NatIpCidrId	string	NAT ゲートウェイの CIDR ブロックの ID です。	vpcnatcidr-gw8ov42ei6xh1jys2****
IsDefault	boolean	CIDR ブロックが NAT ゲートウェイのデフォルト CIDR ブロックかどうかを示します。有効な値は次のとおりです。 true：CIDR ブロックは NAT ゲートウェイのデフォルト CIDR ブロックです。 false：CIDR ブロックは NAT ゲートウェイのデフォルト CIDR ブロックではありません。	true
NatIpCidrStatus	string	NAT ゲートウェイの CIDR ブロックのステータスです。Available が返された場合、CIDR ブロックが利用可能であることを示します。	Available
NatIpCidrName	string	NAT ゲートウェイの CIDR ブロックの名前です。	Name
NatIpCidr	string	NAT ゲートウェイの CIDR ブロックです。	172.16.0.0/24
NatGatewayId	string	VPC NAT ゲートウェイの ID です。	ngw-gw8v16wgvtq26vh59****
NatIpCidrDescription	string	NAT ゲートウェイの CIDR ブロックの説明です。	test

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.

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

変更履歴

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