リージョン内の NAT Gateway を照会します。

デバッグ

OpenAPI Explorer を使用してデバッグ操作を実行し、SDK コード例を生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 値の例 説明
Action String 必須 DescribeNatGateways

操作の実行に使用する API (DescribeNatGateways) を設定します。

RegionId String 必須 cn-hangzhou

NAT Gateway が設定されているリージョンの ID を設定します。 リージョン ID を照会するには、DescribeRegions を呼び出します。

InstanceChargeType String 任意 PostPaid

省略可能なパラメーターです。 NAT Gateway の課金方法を設定します。 現在、従量課金のみサポートされています。

PostPaid: 従量課金
Name String 任意 NAT Gateway

省略可能なパラメーターです。 NAT Gateway の名前を設定します。
NatGatewayId String 任意 ngw-bp1uewa15k4iy5770xxxx

省略可能なパラメーターです。 NAT Gateway の ID を設定します。

PageNumber Integer 任意 10

省略可能なパラメーターです。 ページ番号を設定します。 デフォルト値は 1 です。

PageSize Integer 任意 1

省略可能なパラメーターです。 照会結果をページごとに区切る場合の 1 ページあたりのエントリ数を設定します。 最大値は 50 です。 デフォルト値は 10 です。

Spec String 任意 Large

省略可能なパラメーターです。 NAT Gateway の仕様を設定します。 設定可能な値は次のとおりです。

  • Small (デフォルト値)
  • Middle
  • Large
  • XLarge.1
VpcId String 任意 vpc-bp15zckdt37pq72zxxxx

省略可能なパラメーターです。 VPC の ID を示します。

レスポンスパラメーター

パラメーター データ型 値の例 説明
NatGateways

NAT Gateway の詳細情報を示します。
AutoPay Boolean true

NAT Gateway のオーダーが自動支払いであるかどうかを示します。 想定される値は次のとおりです。

  • false: 自動支払いは有効になっていません。 注文後、オーダーセンターで支払いを完了する必要があります。
  • true: 自動支払いが有効になっており、オーダーに対する支払いは自動的に行われます。
注 InstanceChargeType パラメーターが PrePaid に設定されている場合に必要なパラメーターです。
BandwidthPackageIds bwp-s6lmotmkk

NAT Gateway に関連付けられた帯域幅パッケージの ID を示します。
BusinessStatus String Normal

NAT Gateway のステータスを示します。

  • Normal: NAT Gateway は正常に動作しています。
  • FinancialLocked: 料金が期日までに支払われていないため、NAT Gateway はロックされています。
  • SecurityLocked: セキュリティ上の理由により、NAT Gateway はロックされています。
CreationTime String 2017-06-08T12:20:55

NAT Gateway が作成された時刻を示します。 このパラメーターは ISO 8601 形式を使用し、出力は UTC + 8 時間です。 形式は、YYYY-MM-DDThh:mm です。

Description String NAT

NAT Gateway であることを示します。
ExpiredTime String 2017-08-26T16:00Z

NAT Gateway の有効期限を示します。
ForwardTableIds ftb-uf6gj3mhsg94qsqstfqsx

ポート転送テーブルの ID を示します。
InstanceChargeType String PostPaid

NAT Gateway の課金方法を示します。 現在、従量課金のみサポートされています。

PostPaid: 従量課金
IpLists

NATゲートウェイに関連付けられた EIP (Elastic IP Address) を示します。
IpAddress String 116.62.222.xx

クライアントの IP アドレスを示します。
Name String abc

NAT Gateway の名前を示します。
NatGatewayId String ngw-bp1047e2d4z7kf2kixxxx

NAT Gateway の ID を示します。

RegionId String cn-hangzhou

NAT Gateway が設定されているリージョンの ID を示します。
SnatTableIds stb-uf6dalcdu0krz423pv8mq

NAT Gateway の SNAT テーブルの ID を示します。
Spec String Small

NAT Gateway の仕様を示します。
Status String Initiating

NAT Gateway のステータスを示します。 想定される値は次のとおりです。

  • Initiating: NAT Gateway は初期化中です。
  • Available: : NAT Gateway は利用可能です。
  • Pending: NAT Gateway は設定中です。
VpcId String vpc-bp15zckdt37pq72xxxx

NAT Gateway が設定されている VPC の ID を示します。
TotalCount Integer 10

エントリの合計数を示します。
PageNumber Integer 10

現在のページ番号を示します。
PageSize Integer 10

ページごとのエントリ数を示します。
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

リクエストの ID を示します。

例

リクエストの例


https://vpc.aliyuncs.com/?Action=DescribeNatGateways
&RegionId=cn-hangzhou
&<CommonParameters>

レスポンスの例

XML 形式 

<DescribeNatGatewaysResponse>
	  <PageNumber>1</PageNumber>
	  <TotalCount>1</TotalCount>
	  <PageSize>10</PageSize>
	  <RequestId>1207C80C-7CAB-4874-A9A0-D19EC9F35490</RequestId>
	  <NatGateways>
		    <NatGateway>
			      <Description></Description>
			      <Spec>Small</Spec>
			      <IpLists>
				        <IpList>
					          <IpAddress>118.31.65.181</IpAddress>
					          <AllocationId>eip-bp1xyg5ipmh3nledxywxf</AllocationId>
					          <UsingStatus>UsedBySnatTable</UsingStatus>
				        </IpList>
				        <IpList>
					          <IpAddress>47.97.187.34</IpAddress>
					          <AllocationId>eip-bp19eue77u20cffjcu4ea</AllocationId>
					          <UsingStatus>UsedByForwardTable</UsingStatus>
				        </IpList>
			      </IpLists>
			      <ForwardTableIds>
				        <ForwardTableId>ftb-bp15o9aylj19vfvgtnzoy</ForwardTableId>
			      </ForwardTableIds>
			      <VpcId>vpc-bp15k6sx6fhdz2jw4daz0</VpcId>
			      <NatGatewayId>ngw-bp1047e2d4z7kf2kiy25t</NatGatewayId>
			      <CreationTime>2018-01-10T09:48:29Z</CreationTime>
			      <BandwidthPackageIds></BandwidthPackageIds>
			      <Name></Name>
			      <Status>Available</Status>
			      <BusinessStatus>Normal</BusinessStatus>
			      <RegionId>cn-hangzhou</RegionId>
			      <SnatTableIds>
				        <SnatTableId>stb-bp1tyr0o48w6wymur4gvn</SnatTableId>
			      </SnatTableIds>
			      <InstanceChargeType>PostPaid</InstanceChargeType>
		    </NatGateway>
	  </NatGateways>
</DescribeNatGatewaysResponse>

JSON 形式 

{
	"PageNumber":1,
	"TotalCount":1,
	"PageSize":10,
	"RequestId":"1207C80C-7CAB-4874-A9A0-D19EC9F35490",
	"NatGateways":{
		"NatGateway":[
			{
				"Description":"",
				"Spec":"Small",
				"IpLists":{
					"IpList":[
						{
							"IpAddress":"118.31.65.181",
							"AllocationId":"eip-bp1xyg5ipmh3nledxywxf",
							"UsingStatus":"UsedBySnatTable"
						},
						{
							"IpAddress":"47.97.187.34",
							"AllocationId":"eip-bp19eue77u20cffjcu4ea",
							"UsingStatus":"UsedByForwardTable"
						}
					]
				},
				"ForwardTableIds":{
					"ForwardTableId":[
						"ftb-bp15o9aylj19vfvgtnzoy"
					]
				},
				"VpcId":"vpc-bp15k6sx6fhdz2jw4daz0",
				"NatGatewayId":"ngw-bp1047e2d4z7kf2kiy25t",
				"CreationTime":"2018-01-10T09:48:29Z",
				"BandwidthPackageIds":{
					"BandwidthPackageId":[]
				},
				"Name":"",
				"Status":"Available",
				"BusinessStatus":"Normal",
				"RegionId":"cn-hangzhou",
				"SnatTableIds":{
					"SnatTableId":[
						"stb-bp1tyr0o48w6wymur4gvn"
					]
				},
				"InstanceChargeType":"PostPaid"
			}
		]
	}
}

エラー

HTTP ステータスコード エラーコード エラーメッセージ 説明
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. 指定された RegionId が存在しない場合に返されるエラーメッセージです。

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