すべてのプロダクト
Search

このプロダクト

    ENS:DescribeNatGateways

    ドキュメントセンター

    ENS:DescribeNatGateways

    最終更新日:Mar 20, 2026

    DescribeNatGateways を呼び出して、作成済みの NAT Gateway をクエリします。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ens:DescribeNatGateways

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    EnsRegionId

    string

    任意

    Edge Node Service (ENS) ノードの ID。

    cn-wuxi-9
    NatGatewayId

    string

    任意

    NAT Gateway の ID。

    nat-5t7nh1cfm6kxiszlttr38****
    NetworkId

    string

    任意

    ネットワークの ID。

    n-2zeuphj08tt7q3brd****
    VSwitchId

    string

    任意

    vSwitch の ID。

    vsw-5rllcjb3ol6duzjdnbm1o****
    Name

    string

    任意

    NAT Gateway の名前。

    test0
    NatGatewayIds

    array

    任意

    NAT Gateway の ID。1 ～ 100 個の ID を指定できます。

    string

    任意

    NAT Gateway の ID。

    nat-5****4ik
    EnsRegionIds

    array

    任意

    エッジノードの ID。1 ～ 100 個の ID を指定できます。

    string

    任意

    エッジノードの ID。

    cn-chengdu-telecom-4
    PageNumber

    integer

    任意

    ページ番号。ページは 1 から始まります。

    デフォルト値：1。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。最大値は 100 です。

    デフォルト値：10。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンススキーマ

    RequestId

    string

    リクエストの ID。

    2818A8F4-5E2B-5611-8732-5ACF7B677059
    PageNumber

    integer

    ページ番号。

    1
    TotalCount

    integer

    返される NAT Gateway の数。

    49
    PageSize

    integer

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

    10
    NatGateways

    array<object>

    NAT Gateway の詳細。

    array<object>

    NAT Gateway の詳細。

    EnsRegionId

    string

    ENS ノードの ID。

    cn-xiangyang-5
    NatGatewayId

    string

    NAT Gateway の ID。

    nat-5t7nh1cfm6kxiszlttr38****
    NetworkId

    string

    ネットワークの ID。

    n-5s2ml1olj0kzaws9n1yrj****
    VSwitchId

    string

    vSwitch の ID。

    vsw-5szpp1os9m55myirbflfw****
    Name

    string

    NAT Gateway の名前。

    test0
    CreationTime

    string

    NAT Gateway が作成された時刻。時刻は ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ 形式に従います。時刻は協定世界時 (UTC) で表示されます。

    2021-11-22T07:03:32Z
    Spec

    string

    NAT Gateway のタイプ。

    enat.default
    Status

    string

    NAT Gateway のステータス。有効な値：

    • Creating：NAT Gateway の作成リクエストを送信すると、システムはバックグラウンドで NAT Gateway を作成します。NAT Gateway は、操作が完了するまで Creating 状態のままです。

    • Available：作成が完了すると、NAT Gateway は Available 状態になります。

    • Deleting：NAT Gateway の削除リクエストを送信すると、システムはバックグラウンドで NAT Gateway を削除します。NAT Gateway は、操作が完了するまで Deleting 状態のままです。

    Available
    IpLists

    array<object>

    NAT Gateway に関連付けられている EIP。

    object

    NAT Gateway に関連付けられている EIP。

    UsingStatus

    string

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

    • UsedByForwardTable：EIP は DNAT エントリで指定されています。

    • UsedBySnatTable：EIP は SNAT エントリで指定されています。

    • Idle：EIP は SNAT エントリまたは DNAT エントリで指定されていません。

    Idle
    IpAddress

    string

    EIP。

    8.XX.XX.162
    AllocationId

    string

    EIP の ID。

    eip-50g****
    Tags

    array<object>

    タグのコレクション。

    object

    タグのコレクション。

    Value

    string

    タグ値。

    TestValue
    Key

    string

    タグキー。

    TestKey
    TagKey deprecated

    string

    タグキー。

    TestKey
    TagValue deprecated

    string

    タグ値。

    TestValue

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "2818A8F4-5E2B-5611-8732-5ACF7B677059",
  "PageNumber": 1,
  "TotalCount": 49,
  "PageSize": 10,
  "NatGateways": [
    {
      "EnsRegionId": "cn-xiangyang-5",
      "NatGatewayId": "nat-5t7nh1cfm6kxiszlttr38****",
      "NetworkId": "n-5s2ml1olj0kzaws9n1yrj****",
      "VSwitchId": "vsw-5szpp1os9m55myirbflfw****",
      "Name": "test0",
      "CreationTime": "2021-11-22T07:03:32Z",
      "Spec": "enat.default",
      "Status": "Available",
      "IpLists": [
        {
          "UsingStatus": "Idle",
          "IpAddress": "8.XX.XX.162",
          "AllocationId": "eip-50g****"
        }
      ],
      "Tags": [
        {
          "Value": "TestValue",
          "Key": "TestKey",
          "TagKey": "TestKey",
          "TagValue": "TestValue"
        }
      ]
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Invalid%s The specified parameter %s is invalid.
    400 Missing%s You must specify the parameter %s.
    400 ens.interface.error Failed to call API.
    400 NoPermission Permission denied.
    400 InvalidParameter.%s The specified field %s invalid. Please check it again.

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

    変更履歴

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