すべてのプロダクト
Search

このプロダクト

    NAT Gateway:DescribeNatGateways

    ドキュメントセンター

    NAT Gateway:DescribeNatGateways

    最終更新日:Jun 17, 2026

    指定されたリージョンで指定された条件に一致する NAT ゲートウェイの詳細情報を照会します。

    操作説明

    この操作は、インターネット NAT ゲートウェイまたは VPC NAT ゲートウェイの詳細情報のクエリをサポートしています。このドキュメントで使用される「NAT ゲートウェイ」という term は、2 つのタイプを区別しません。

    今すぐお試しください

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

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    vpc:DescribeNatGateways

    get

    NatGateway

    acs:vpc:{#regionId}:{#accountId}:natgateway/*

    NatGateway

    acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    クエリする NAT ゲートウェイのリージョン ID。

    DescribeRegions 操作を呼び出してリージョン ID を取得できます。

    cn-hangzhou
    NatGatewayId

    string

    任意

    クエリする NAT ゲートウェイの ID。

    ngw-bp1uewa15k4iy5770****
    VpcId

    string

    任意

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

    vpc-bp15zckdt37pq72z****
    Name

    string

    任意

    クエリする NAT ゲートウェイの名前。

    名前は 1～128 文字で、http:// または https:// で始めることはできません。

    test
    InstanceChargeType

    string

    任意

    • PrePaid: レガシのサブスクリプション課金方法。サブスクリプション課金方法は新規購入では利用できなくなりました。

    クエリする NAT ゲートウェイインスタンスの課金方法。有効な値: PostPaid (従量課金)。.

    PostPaid
    Spec

    string

    任意

    NAT ゲートウェイのスペック。このパラメーターは空のままにしてください。.

    中国站示例值：Small，国际站示例值：无需填写
    NatType

    string

    任意

    NAT ゲートウェイのタイプ。有効な値: Enhanced (拡張 NAT ゲートウェイ)。

    Enhanced
    ResourceGroupId

    string

    任意

    NAT ゲートウェイが属するリソースグループの ID。

    rg-bp67acfmxazb4ph****
    PageNumber

    integer

    任意

    ページ番号。デフォルト値: 1。

    10
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10。

    1
    DryRun

    boolean

    任意

    ドライランを実行するかどうかを指定します。有効な値:

    • true: リソースステータスをクエリせずにドライランを実行します。チェック項目には、AccessKey ペアが有効かどうか、RAM ユーザーが認可されているかどうか、必須パラメーターが指定されているかどうかが含まれます。チェックが失敗した場合、対応するエラーが返されます。チェックが成功した場合、エラーコード DryRunOperation が返されます。

    • false (デフォルト): 通常のリクエストを実行します。チェックが成功した後、2xx HTTP 状態コードが返され、リソースステータスが直接クエリされます。

    false
    Status

    string

    任意

    クエリする NAT ゲートウェイのステータス。有効な値:

    • Creating: NAT ゲートウェイの作成は非同期操作です。作成が完了するまでステータスは Creating です。

    • Available: NAT ゲートウェイが作成され、使用可能です。これは安定したステータスです。

    • Modifying: NAT ゲートウェイの変更は非同期操作です。変更プロセス中のステータスは Modifying です。

    • Deleting: NAT ゲートウェイの削除は非同期操作です。削除プロセス中のステータスは Deleting です。

    • Converting: 標準 NAT ゲートウェイから拡張 NAT ゲートウェイへの変換は非同期操作です。変換プロセス中のステータスは Converting です。

    Available
    NetworkType

    string

    任意

    クエリする NAT ゲートウェイのタイプ。有効な値:

    • internet: インターネット NAT ゲートウェイ。

    • intranet: VPC NAT ゲートウェイ。

    internet
    Tag

    array<object>

    任意

    タグのリスト。

    object

    任意

    タグのリスト。

    Key

    string

    任意

    NAT ゲートウェイインスタンスのタグキー。最大 20 個のタグキーを指定できます。

    タグキーは最大 128 文字です。aliyun または acs: で始めることはできず、http:// または https:// を含めることはできません。

    KeyTest
    Value

    string

    任意

    NAT ゲートウェイインスタンスのタグ値。最大 20 個のタグ値を指定できます。

    タグ値は最大 128 文字です。aliyun または acs: で始めることはできず、http:// または https:// を含めることはできません。

    valueTest
    ZoneId

    string

    任意

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

    cn-hangzhou-b
    AvailabilityMode

    string

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    1 ページあたりのエントリ数。

    PageSize

    integer

    1 ページあたりのエントリ数。

    10
    RequestId

    string

    リクエスト ID。

    4EC47282-1B74-4534-BD0E-403F3EE64CAF
    PageNumber

    integer

    現在のページ番号。

    10
    TotalCount

    integer

    NAT ゲートウェイリストのエントリの総数。

    1
    NatGateways

    object

    NatGateway

    array<object>

    NAT ゲートウェイの詳細情報。

    array<object>

    NAT ゲートウェイの詳細情報。

    Status

    string

    NAT Gateway のステータスです。有効値は次のとおりです。

    • Creating：NAT Gateway を作成中です。プロセスは非同期です。

    • Available：NAT Gateway は安定しており、使用可能です。

    • Modifying：NAT Gateway を変更中です。プロセスは非同期です。

    • Deleting：NAT Gateway を削除中です。プロセスは非同期です。

    • Converting：NAT Gateway を基本 NAT ゲートウェイから拡張 NAT ゲートウェイに変換中です。プロセスは非同期です。

    Creating
    CreationTime

    string

    NAT Gateway の作成時刻です。

    2021-06-08T12:20:20Z
    VpcId

    string

    NAT Gateway がデプロイされている VPC の ID です。

    vpc-bp15zckdt37pq72z****
    NatType

    string

    NAT Gateway のタイプです。Enhanced は拡張 NAT ゲートウェイを示します。

    Enhanced
    AutoPay

    boolean

    注文を自動的に支払うかどうかを示します。有効値は次のとおりです。

    • false：注文は自動的に支払われません。

    • true：注文は自動的に支払われます。

    false
    Spec

    string

    NAT Gateway の仕様です。このパラメーターは空です。

    InternetChargeType が PayByLcu の場合、このパラメーターは空になります。

    Small
    DeletionProtection

    boolean

    削除保護が有効かどうかを示します。有効値は次のとおりです。

    • true：有効

    • false：無効

    true
    NetworkType

    string

    NAT Gateway のタイプです。有効値は次のとおりです。

    • internet：インターネット NAT Gateway

    • intranet：VPC NAT ゲートウェイ

    internet
    SecurityProtectionEnabled

    boolean

    ファイアウォール機能が有効かどうかを示します。有効値は次のとおりです。

    • false：ファイアウォール機能は無効です。

    • true：ファイアウォール機能は有効です。

    false
    InstanceChargeType

    string

    NAT Gateway インスタンスの課金方法は PostPaid（従量課金）です。

    PostPaid
    RegionId

    string

    NAT Gateway がデプロイされているリージョンの ID です。

    cn-hangzhou
    EcsMetricEnabled

    boolean

    トラフィックモニタリング機能が有効かどうかを示します。有効値は次のとおりです。

    • true：有効

    • false：無効

    true
    IcmpReplyEnabled

    boolean

    ICMP 応答機能が有効かどうかを示します。有効値は次のとおりです。

    • true（デフォルト）：有効

    • false：無効

    true
    Description

    string

    NAT Gateway の説明です。

    NAT
    ExpiredTime

    string

    NAT Gateway の有効期限切れ時刻です。

    2021-08-26T16:00Z
    ResourceGroupId

    string

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

    rg-bp67acfmxazb4ph****
    NatGatewayId

    string

    NAT Gateway の ID です。

    ngw-bp1047e2d4z7kf2ki****
    InternetChargeType

    string

    NAT Gateway の課金タイプです。有効値は次のとおりです。

    • PayBySpec：仕様別課金

    • PayByLcu：CU 別課金

    PayByLcu
    BusinessStatus

    string

    NAT Gateway のビジネスステータスです。有効値は次のとおりです。

    • Normal：NAT Gateway は正常に動作しています。

    • FinancialLocked：NAT Gateway は支払い遅延によりロックされています。

    Normal
    Name

    string

    NAT Gateway インスタンスの名前です。

    abc
    IpLists

    object

    IpList

    array<object>

    インターネット NAT Gateway に関連付けられた EIP のリストです。

    object

    NAT Gateway に関連付けられた EIP の詳細です。

    UsingStatus

    string

    インターネット NAT Gateway に関連付けられた EIP のステータスです。有効値は次のとおりです。

    • UsedByForwardTable：EIP は DNAT ルールで使用されています。

    • UsedBySnatTable：EIP は SNAT ルールで使用されています。

    • UsedByForwardSnatTable：EIP は DNAT ルールおよび SNAT ルールで使用されています。

    • Idle：EIP は DNAT ルールまたは SNAT ルールで使用されていません。

    UsedByForwardTable
    IpAddress

    string

    NAT Gateway に関連付けられた EIP の IP アドレスです。

    116.62.XX.XX
    SnatEntryEnabled

    boolean

    DNAT ルールで使用されている IP アドレスを SNAT ルールでも使用できるかどうかを示します。有効値は次のとおりです。

    • true：IP アドレスを SNAT エントリでも使用できます。

    • false：IP アドレスを SNAT エントリで使用することはできません。

    false
    AllocationId

    string

    NAT Gateway に関連付けられた EIP の ID です。

    eip-m5egzuvp3dgixen6****
    PrivateIpAddress

    string

    NAT Gateway のプライベート IP アドレスです。

    192.168.XX.XX
    ForwardTableIds

    object

    ForwardTableId

    array

    DNAT テーブル ID のリストです。

    string

    DNAT テーブルの ID です。

    ftb-uf6gj3mhsg94qsqst****
    SnatTableIds

    object

    SnatTableId

    array

    SNAT テーブル ID のリストです。

    string

    SNAT テーブルの ID です。

    stb-uf6dalcdu0krz423p****
    FullNatTableIds

    object

    FullNatTableId

    array

    FULLNAT テーブル ID のリストです。

    string

    FULLNAT テーブルの ID です。

    fulltb-gw88z7hhlv43rmb26****
    NatGatewayPrivateInfo

    object

    拡張インターネット NAT Gateway のプライベートネットワークの詳細です。

    説明

    NatType が Normal に設定されている場合、このオブジェクト内のパラメーターは空になります。

    VswitchId

    string

    NAT Gateway が属する VSwitch の ID です。

    vsw-bp1s2laxhdf9ayjbo****
    EniInstanceId

    string

    エラスティックネットワークインターフェース (ENI) の ID です。

    eni-m5eg4ozy5st8q3q4****
    MaxBandwidth

    integer

    最大帯域幅です。単位は Mbps です。

    5120
    MaxSessionQuota

    integer

    最大同時接続数です。

    2000000
    MaxSessionEstablishRate

    integer

    最大新規接続レート（接続/秒）です。

    100000
    PrivateIpAddress

    string

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

    192.168.XX.XX
    IzNo

    string

    NAT Gateway がデプロイされているゾーンです。

    cn-hangzhou-b
    EniType

    string

    ENI が NAT Gateway に関連付けられるモードです。有効値は次のとおりです。

    • indirect：非直接接続モード

    • 空の値が返された場合、直接接続モードを示します。

    indirect
    PrivateLinkEnabled

    boolean

    PrivateLink が有効かどうかを示します。有効値は次のとおりです。

    • true：PrivateLink は有効です。

    • false：PrivateLink は無効です。

    true
    PrivateLinkMode

    string

    PrivateLink サービスのモードです。有効値は次のとおりです。

    • FullNat：FULLNAT モード

    • Geneve：Geneve モード

    FullNat
    EipBindMode

    string

    EIP が NAT Gateway に関連付けられるモードです。有効値は次のとおりです。

    • MULTI_BINDED：マルチ EIP NIC 表示モード

    • NAT：標準 EIP モード（IPv4 ゲートウェイと互換）

    説明

    NAT Gateway が標準 EIP モードを使用している場合、各 EIP は NAT Gateway がデプロイされている VSwitch からプライベート IP アドレスを 1 つ消費します。VSwitch に十分な数のプライベート IP アドレスがあることを確認してください。VSwitch のプライベート IP アドレスが枯渇すると、新しい EIP を NAT Gateway に関連付けることができなくなります。標準 EIP モードでは、NAT Gateway に最大 50 個の EIP を関連付けることができます。

    MULTI_BINDED
    Tags

    object

    Tag

    array<object>

    タグのリストです。

    object

    キーと値のペアで構成されるタグオブジェクトです。

    TagKey

    string

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

    KeyTest
    TagValue

    string

    インスタンスのタグ値です。

    valueTest
    EnableSessionLog

    string

    セッションログ機能が有効かどうかを示します。有効値は次のとおりです。

    • true：有効

    • false：無効

    true
    AccessMode

    object

    VPC NAT ゲートウェイのリバースアクセスモードです。

    ModeValue

    string

    アクセスモードです。有効値は次のとおりです。

    • route：ルートモード

    • tunnel：トンネルモード

    route
    TunnelType

    string

    トンネルモードのタイプです。

    • geneve：Geneve

    geneve
    AvailabilityMode

    string

    IpPrefixList

    object

    IpPrefixList

    array<object>

    NAT IP プレフィックスのリストです。

    object

    IpPrefix

    string

    NAT IP プレフィックスです。

    192.168.0.0/28

    例

    成功レスポンス

    JSONJSON

    {
  "PageSize": 10,
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "PageNumber": 10,
  "TotalCount": 1,
  "NatGateways": {
    "NatGateway": [
      {
        "Status": "Creating",
        "CreationTime": "2021-06-08T12:20:20Z",
        "VpcId": "vpc-bp15zckdt37pq72z****",
        "NatType": "Enhanced",
        "AutoPay": false,
        "Spec": "Small",
        "DeletionProtection": true,
        "NetworkType": "internet",
        "SecurityProtectionEnabled": false,
        "InstanceChargeType": "PostPaid",
        "RegionId": "cn-hangzhou",
        "EcsMetricEnabled": true,
        "IcmpReplyEnabled": true,
        "Description": "NAT",
        "ExpiredTime": "2021-08-26T16:00Z",
        "ResourceGroupId": "rg-bp67acfmxazb4ph****",
        "NatGatewayId": "ngw-bp1047e2d4z7kf2ki****",
        "InternetChargeType": "PayByLcu",
        "BusinessStatus": "Normal",
        "Name": "abc",
        "IpLists": {
          "IpList": [
            {
              "UsingStatus": "UsedByForwardTable",
              "IpAddress": "116.62.XX.XX",
              "SnatEntryEnabled": false,
              "AllocationId": "eip-m5egzuvp3dgixen6****",
              "PrivateIpAddress": "192.168.XX.XX"
            }
          ]
        },
        "ForwardTableIds": {
          "ForwardTableId": [
            "ftb-uf6gj3mhsg94qsqst****"
          ]
        },
        "SnatTableIds": {
          "SnatTableId": [
            "stb-uf6dalcdu0krz423p****"
          ]
        },
        "FullNatTableIds": {
          "FullNatTableId": [
            "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": "indirect"
        },
        "PrivateLinkEnabled": true,
        "PrivateLinkMode": "FullNat",
        "EipBindMode": "MULTI_BINDED",
        "Tags": {
          "Tag": [
            {
              "TagKey": "KeyTest",
              "TagValue": "valueTest"
            }
          ]
        },
        "EnableSessionLog": "true",
        "AccessMode": {
          "ModeValue": "route",
          "TunnelType": "geneve"
        },
        "AvailabilityMode": "",
        "IpPrefixList": {
          "IpPrefixList": [
            {
              "IpPrefix": "192.168.0.0/28"
            }
          ]
        }
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError The request processing has failed due to some unknown error, exception or failure.
    404 InvalidRegionId.NotFound The specified RegionId does not exist in our records.

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

    変更履歴

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