特定のリージョンで特定の条件を満たすNAT Gatewayを照会します。

使用上の注意

このAPIを呼び出して、Virtual Private Cloud (VPC) NATゲートウェイとインターネットNATゲートウェイの両方を照会できます。 このトピックのNAT Gatewayは、VPC NAT GatewayとインターネットNAT Gatewayの両方を指します。

デバッグ

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

リクエストパラメーター

項目 データ型 必須/任意 例: 説明 
操作 String 必須 DescribeNatGateways

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

RegionId String 必須 cn-hangzhou

照会するNAT GatewayのリージョンID。

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

NatGatewayId String 任意 ngw-bp1uewa15k4iy5770 ****

NAT ゲートウェイの ID 。

VpcId String 任意 vpc-bp15zckdt37pq72z ****

NATゲートウェイが属するVPCのID。

名前 String 任意 test

NATゲートウェイの名前。

名前は2 ~ 128文字で、英数字、アンダースコア (_) 、ハイフン (-) を使用できます。 先頭は英字とする必要があります。

このパラメーターが設定されていない場合、システムは自動的にNATゲートウェイに名前を割り当てます。

InstanceChargeType String 任意 PostPaid

NAT gatewayの課金方法。 値をPostPaidに設定します。これは、従量課金の課金方法を指定します。

Spec String 任意 Alibaba Cloud Chinaサイトの値の例: Small。 Alibaba Cloud Internationalサイトを使用している場合、このパラメーターは無視してください。

NATゲートウェイのサイズ。 このパラメーターを無視します。

ナットタイプ String 任意 Enhanced

NAT gatewayのタイプ。 値を拡張 (拡張NATゲートウェイ) に設定します。

ResourceGroupId String 任意 rg-bp67acfmxazb4ph ****

NAT gatewayが属するリソースグループのID。

PageNumber Integer いいえ 10

返されるページ数。 既定値:1

PageSize Integer いいえ 1

各ページで返されるエントリ数。 最大値:50 既定値:1

DryRun Boolean いいえ false

操作を実行せずにリクエストを事前チェックするかどうかを指定します。 有効な値:

  • true: 操作を実行せずにリクエストを事前チェックします。 システムは、AccessKeyペアが有効かどうか、Resource Access Management (RAM) ユーザーが許可されているかどうか、および必要なパラメーターが設定されているかどうかを事前に確認します。 リクエストが事前チェックに合格しなかった場合、対応するエラーメッセージが返されます。 リクエストが事前チェックに合格した場合、DryRunOperationエラーコードが返されます。
  • false: リクエストを送信します。 リクエストが事前チェックに合格した後、2xx HTTPステータスコードが返され、操作が実行されます。 デフォルト値です。
Status String 任意 使用可能

NATゲートウェイのステータス。 有効な値:

  • 作成中: NATゲートウェイの作成要求を送信すると、システムはバックグラウンドでNATゲートウェイを作成します。 NAT gatewayは、操作が完了するまで [作成中] 状態のままです。
  • 使用可能: NATゲートウェイの作成後、NATゲートウェイは安定した状態のままです。
  • 変更: NATゲートウェイを変更するリクエストを送信すると、システムはバックグラウンドでNATゲートウェイを変更します。 NAT gatewayは、操作が完了するまで [変更] 状態のままです。
  • 削除: NATゲートウェイの削除要求を送信すると、システムはバックグラウンドでNATゲートウェイを削除します。 NAT gatewayは、操作が完了するまで [Deleting] 状態のままです。
  • 変換: 標準NATゲートウェイを拡張NATゲートウェイにアップグレードするリクエストを送信すると、システムはバックグラウンドでNATゲートウェイをアップグレードします。 NAT gatewayは、操作が完了するまで [変換] 状態のままです。
NetworkType String 任意 internet

NATゲートウェイのタイプ。 有効な値:

  • internet: インターネットNATゲートウェイ
  • イントラネット: VPC NATゲートウェイ
Tag.N.Key String 任意 KeyTest

NAT gatewayのタグキー。 最大20個のタグキーを指定できます。

各タグキーの長さは64文字を超えることはできません。また、aliyunまたはacs: で始めることはできません。 http:// またはhttps:// は使用できません。

Tag.N.Value String 任意 valueTest

NAT gatewayのタグ値。 最大20個のタグ値を指定できます。

タグ値の長さは128文字を超えることはできません。また、aliyunまたはacs: で始めることはできません。 値にはhttp:// またはhttps:// を含めることはできません。

ZoneId String 任意 cn-hangzhou-d

NAT gatewayが属するゾーンのID。

レスポンスパラメーター

項目 データ型 例: 説明 
PageSize Integer 10

1 ページあたりで返されるエントリ数。

RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

リクエストの ID です。

PageNumber Integer 10

返されたページ数。

TotalCount Integer 1

返されるNAT gatewayエントリの数。

NatGateways NatGatewayの配列

NATゲートウェイの詳細。

NatGateway
Status String 作成中

NATゲートウェイのステータス。 有効な値:

  • 作成中: NATゲートウェイの作成要求を送信すると、システムはバックグラウンドでNATゲートウェイを作成します。 NATゲートウェイは、操作が完了するまで作成中状態のままです。
  • 使用可能: NATゲートウェイの作成後、NATゲートウェイは安定した状態のままです。
  • 変更: NATゲートウェイを変更するリクエストを送信すると、システムはバックグラウンドでNATゲートウェイを変更します。 NATゲートウェイは、操作が完了するまで変更状態のままです。
  • 削除: NATゲートウェイの削除要求を送信すると、システムはバックグラウンドでNATゲートウェイを削除します。 NATゲートウェイは、操作が完了するまで削除状態のままです。
  • 変換: 標準NATゲートウェイを拡張NATゲートウェイにアップグレードするリクエストを送信すると、システムはバックグラウンドでNATゲートウェイをアップグレードします。 NATゲートウェイは、操作が完了するまで変換状態のままです。
CreationTime String 2021-06-08T12:20:20Z

NATゲートウェイが作成された時刻。

VpcId String vpc-bp15zckdt37pq72z ****

NATゲートウェイがデプロイされているVPCのID。

ナットタイプ String Enhanced

NATゲートウェイのタイプ。 値は拡張 (拡張NATゲートウェイ) に設定されます。

AutoPay ブール

自動支払いが有効になっているかどうかを示します。 有効な値:

  • false: いいえ
  • true: はい
Spec String Small

NATゲートウェイのサイズ。 パラメータに空の値が返されます。

InternetChargeTypePayByLcuに設定されている場合、空の値が返されます。

DeletionProtection ブール 真実

削除保護機能が有効になっているかどうかを示します。 有効な値:

  • true: はい
  • false: いいえ
NetworkType String internet

NAT gatewayのタイプ。 有効な値:

  • internet: インターネットNATゲートウェイ
  • イントラネット: VPC NATゲートウェイ
SecurityProtectionEnabled ブール

ファイアウォール機能が有効かどうかを示します。 有効な値:

  • false: いいえ
  • true: はい
InstanceChargeType String PostPaid

NAT gatewayの課金方法。 値はPostPaidに設定され、従量課金の課金方法を示します。

RegionId String cn-hangzhou

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

EcsMetricEnabled ブール 真実

トラフィック監視機能が有効かどうかを示します。 有効な値:

  • true: はい
  • false: いいえ
IcmpReplyEnabled ブール

ICMP非検索機能が有効かどうかを示します。 有効な値:

  • true: はい
  • false: いいえ
説明  String NAT

NATゲートウェイの説明。

ExpiredTime String 2021-08-26T16:00Z

NATゲートウェイの有効期限が切れる時刻。

ResourceGroupId String rg-bp67acfmxazb4ph ****

リソースグループの ID です。

NatGatewayId String ngw-bp1047e2d4z7kf2ki ****

NAT ゲートウェイの ID 。

InternetChargeType String PayByLcu

NATゲートウェイの計測方法。 有効な値:

  • PayBySpec: pay-by-specification
  • PayByLcu: pay-by-CU
BusinessStatus String ノーマル

NATゲートウェイのステータス。 有効な値:

  • Normal: normal
  • FinancialLocked: 延滞支払いのためにロックされました
名前 String こんにちは

NATゲートウェイの名前。

IpLists IpListの配列

インターネットNATゲートウェイに関連付けられているelastic IPアドレス (EIP) のリスト。

IpList
UsingStatus String UsedByForwardTable

EIPとインターネットNATゲートウェイの関連付け。 有効な値:

  • UsedByForwardTable: EIPはDNATエントリで指定されています。
  • UsedBySnatTable: EIPはSNATエントリで指定されています。
  • UsedByForwardSnatTable: EIPはSNATエントリとDNATエントリの両方で指定されています。
  • アイドル: DNATまたはSNATエントリでEIPが指定されていません。
IpAddress String 116.62.XX.XX

NATゲートウェイに関連付けられているEIPのIPアドレス。

SnatEntryEnabled ブール

DNATエントリで使用されているIPアドレスをSNATエントリで指定できるかどうかを示します。 有効な値:

  • true: はい
  • false: いいえ
AllocationId String eip-m5egzuvp3dgixen6 ****

The ID of the EIP associated with the NAT gateway.

PrivateIpAddress String 192.168.XX.XX

NATゲートウェイのプライベートIPアドレス。

ForwardTableId 文字列の配列 ftb-uf6gj3mhsg94qsqst ****

DNATテーブルのID。

SnatTableId 文字列の配列 stb-uf6dalcdu0krz423p ****

NATゲートウェイのSNATテーブルのID。

FullNatTableIds 文字列の配列 fulltb-gw88z7hhlv43rmb26 ****

The ID of the FULLNAT table.

NatGatewayPrivateInfo オブジェクト

拡張インターネットNATゲートウェイに関するプライベートネットワーク情報。

説明 NatTypeNormalに設定されている場合、このリストで返されるすべてのパラメーターは空です。
VswitchId String vsw-bp1s2laxhdf9ayjbo ****

NAT gatewayが属するvSwitchのID。

EniInstanceId String eni-m5eg4ozy5st8q3q4 ****

elastic network interface (ENI) のID。

MaxBandwidth Integer 5120

最大帯域幅。 単位:Mbit/秒。

MaxSessionQuota Integer 2000000

NAT gatewayへの同時接続数。 単位: 接続。

MaxSessionEstablishRate Integer 100000

NATゲートウェイへの新しい接続の数。 単位: 1秒あたりの接続数。

PrivateIpAddress String 192.168.XX.XX

プライベートIPアドレス。

IzNo String cn-hangzhou-b

NAT gatewayが属するゾーン。

EniType String 間接

ENIがNATゲートウェイに関連付けられているモード。

  • 间接: 非カットスルーモード
  • 空の値が返された場合は、カットスルーモードが使用されていることを示します。
PrivateLinkEnabled ブール 真実

NAT gatewayがPrivateLinkをサポートしているかどうかを示します。 有効な値:

  • true: はい
  • false: いいえ
PrivateLinkMode String フルナット

PrivateLinkによって使用されるモード。 有効な値:

  • FullNat: FULLNATモード
  • Geneve: GENEVEモード
EipBindMode String MULTI_BINDED

NATゲートウェイがelastic IPアドレス (EIP) に関連付けられているモード。 有効な値:

  • MULTI_BINDED: マルチEIP-to-ENIモード
  • NAT: NATモード。IPv4アドレスと互換性があります。
説明 注: NATモードを使用する場合、EIPはNATゲートウェイのvSwitchで1つのプライベートIPアドレスを占有します。 vSwitchに十分なプライベートIPアドレスがあることを確認します。 それ以外の場合、NATゲートウェイはEIPに関連付けられません。 NATモードでは、NATゲートウェイを最大50個のEIPに関連付けることができます。
タグ タグの配列

リソースグループに追加されるタグ。

タグ
TagKey String KeyTest

インスタンスのタグキー。

TagValue String valueTest

インスタンスのタグ値。

リクエストの例

http(s)://[Endpoint]/?Action=DescribeNatGateways
&RegionId=cn-hangzhou
&NatGatewayId=ngw-bp1uewa15k4iy5770 ****
&VpcId=vpc-bp15zckdt37pq72z ****
&名前=テスト
&InstanceChargeType=PostPaid
Specパラメータの値の例: Small。 この値は、Chinaサイト (aliyun.com) で使用できます。 国際サイト (alibabacloud.com) を使用する場合は、このパラメーターを無視します。
&NatType=強化
&ResourceGroupId=rg-bp67acfmxazb4ph ****
&ページ番号=10
&PageSize=1
&DryRun=false
&ステータス=利用可能
&NetworkType=インターネット
&タグ=[{}]
&ZoneId=cn-hangzhou-b
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

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

<DescribeNatGatewaysResponse>
    <のPageSize> 10 </がPageSize>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
    <PageNumber>10</PageNumber>
    <TotalCount> 1 </ TotalCount>
    <NatGateways>
        <ステータス> 作成中 </ステータス>
        <CreationTime>2021-06-08T12:20:20Z</CreationTime>
        <VpcId>vpc-bp15zckdt37pq72z ****</VpcId>
        <NatType> 拡張 </NatType>
        <AutoPay>false</AutoPay>
        <Spec> 小さい </Spec>
        <DeletionProtection>true</DeletionProtection>
        <NetworkType> インターネット </NetworkType>
        <SecurityProtectionEnabled>false</SecurityProtectionEnabled>
        <InstanceChargeType>PostPaid</InstanceChargeType>
        <RegionId>cn-hangzhou</RegionId>
        <EcsMetricEnabled>true</EcsMetricEnabled>
        <IcmpReplyEnabled>false</IcmpReplyEnabled>
        <説明> NAT</説明>
        <ExpiredTime>2021-08-26T16:00Z</ExpiredTime>
        <ResourceGroupId>rg-bp67acfmxazb4ph ****</ResourceGroupId>
        <NatGatewayId>ngw-bp1047e2d4z7kf2ki ****</NatGatewayId>
        <InternetChargeType>PayByLcu</InternetChargeType>
        <BusinessStatus>Normal</BusinessStatus>
        <名前> abc</名前>
        <IpLists>
            <UsingStatus>UsedByForwardTable</UsingStatus>
            <IpAddress>116.62.XX.XX</IpAddress>
            <SnatEntryEnabled>false</SnatEntryEnabled>
            <AllocationId>eip-m5egzuvp3dgixen6 ****</AllocationId>
            <PrivateIpAddress>192.168.XX.XX</PrivateIpAddress>
        </IpLists>
        <ForwardTableIds>ftb-uf6gj3mhsg94qsqst ****</ForwardTableIds>
        <SnatTableIds>stb-uf6dalcdu0krz423p ****</SnatTableIds>
        <FullNatTableIds>fulltb-gw88z7hhlv43rmb26 ****</FullNatTableIds>
        <NatGatewayPrivateInfo>
            <VswitchId>vsw-bp1s2laxhdf9ayjbo ****</VswitchId>
            <EniInstanceId>eni-m5eg4ozy5st8q3q4 ****</EniInstanceId>
            <MaxBandwidth>5120</MaxBandwidth>
            <MaxSessionQuota>2000000</MaxSessionQuota>
            <MaxSessionEstablishRate>100000</MaxSessionEstablishRate>
            <PrivateIpAddress>192.168.XX.XX</PrivateIpAddress>
            <IzNo>cn-hangzhou-b</IzNo>
            <EniType> 間接 </EniType>
        </NatGatewayPrivateInfo>
        <PrivateLinkEnabled>true</PrivateLinkEnabled>
        <PrivateLinkMode>FullNat</PrivateLinkMode>
        <EipBindMode>MULTI_BINDED</EipBindMode>
        <タグ>
            <TagKey> キーテスト </TagKey>
            <TagValue>valueTest</TagValue>
        </タグ>
    </NatGateways>
</DescribeNatGatewaysResponse>

JSON 形式

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

{
  "PageSize" : 10,
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF" 、
  "PageNumber" : 10、
  "TotalCount" : 1、
  "NatGateways" : [ {
    "ステータス" : "作成中" 、
    "CreationTime" : "2021-06-08T12:20:20Z" 、
    "VpcId" : "vpc-bp15zckdt37pq72z ****" 、
    "NatType" : "Enhanced" 、
    "AutoPay" : false、
    "スペック" : "小さい" 、
    "DeletionProtection" : true、
    "NetworkType" : "インターネット" 、
    "SecurityProtectionEnabled" : false、
    "InstanceChargeType" : "PostPaid" 、
    "RegionId" : "cn-hangzhou" 、
    "EcsMetricEnabled" : true、
    "IcmpReplyEnabled" : false、
    「説明」: 「NAT」、
    "ExpiredTime" : "2021-08-26T16:00Z" 、
    "ResourceGroupId" : "rg-bp67acfmxazb4ph ****" 、
    "NatGatewayId" : "ngw-bp1047e2d4z7kf2ki ****" 、
    "InternetChargeType" : "PayByLcu" 、
    "BusinessStatus" : "Normal" 、
    "Name" : "abc" 、
    "IpLists" : [ {
      "UsingStatus" : "UsedByForwardTable" 、
      "IpAddress" : "116.62.XX.XX" 、
      "SnatEntryEnabled" : false、
      "AllocationId" : "eip-m5egzuvp3dgixen6 ****" 、
      "PrivateIpAddress" : "192.168.XX.XX"
    } ],
    "ForwardTableIds" : [ "ftb-uf6gj3mhsg94qsqst ****"] 、
    "SnatTableIds" : [ "stb-uf6dalcdu0krz423p ****"] 、
    "FullNatTableIds" : [ "fulltb-gw88z7hhlv43rmb26 ****"] 、
    "NatGatewayPrivateInfo" : {
      "VswitchId" : "vsw-bp1s2laxhdf9ayjbo ****" 、
      "EniInstanceId" : "eni-m5eg4ozy5st8q3q4 ****" 、
      "MaxBandwidth" : 5120、
      "MaxSessionQuota" : 2000000、
      "MaxSessionEstablishRate" : 100000、
      "PrivateIpAddress" : "192.168.XX.XX" 、
      "IzNo" : "cn-hangzhou-b" 、
      "EniType" : "間接"
    },
    "PrivateLinkEnabled" : true、
    "PrivateLinkMode" : "FullNat" 、
    "EipBindMode" : "MULTI_BINDED" 、
    "タグ" : [ {
      "TagKey" : "KeyTest" 、
      "TagValue" : "valueTest"
    } ]
  } ]
}

エラーコード

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

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