すべてのプロダクト
Search
ドキュメントセンター

NAT Gateway:GetNatGatewayAttribute

最終更新日:Aug 27, 2026

単一の NAT ゲートウェイインスタンスの情報を照会します。

操作説明

この操作は、単一のインターネット NAT ゲートウェイまたは VPC NAT ゲートウェイの情報を照会します。本 Topic における「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:GetNatGatewayAttribute

get

*NatGateway。

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

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

RegionId

string

必須

NAT ゲートウェイのリージョン ID。

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

cn-qingdao

NatGatewayId

string

必須

NAT ゲートウェイのインスタンス ID。

ngw-bp1b0lic8uz4r6vf2****

レスポンスフィールド

フィールド

型

説明

例

object

VpcId

string

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

vpc-bp15zckdt37pq72z****

CreationTime

string

NAT ゲートウェイが作成された時間。時間は YYYY-MM-DDThh:mm:ssZ フォーマットで表示されます。

2021-12-08T12:20:20Z

Status

string

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

  • Creating: NAT ゲートウェイは作成中です。NAT ゲートウェイの作成は非同期操作です。操作が完了するまで、NAT ゲートウェイは Creating 状態のままです。

  • Available: NAT ゲートウェイは使用可能です。これは NAT ゲートウェイ作成後の安定した状態です。

  • Modifying: NAT ゲートウェイは変更済みです。NAT ゲートウェイの変更は非同期操作です。操作が完了するまで、NAT ゲートウェイは Modifying 状態のままです。

  • Deleting: NAT ゲートウェイは削除中です。NAT ゲートウェイの削除は非同期操作です。操作が完了するまで、NAT ゲートウェイは Deleting 状態のままです。

  • Converting: NAT ゲートウェイは変換中です。標準 NAT ゲートウェイから拡張 NAT ゲートウェイへの変換は非同期操作です。操作が完了するまで、NAT ゲートウェイは Converting 状態のままです。

Available

NatType

string

インターネット NAT ゲートウェイのタイプ。値は Enhanced で、拡張 NAT ゲートウェイを示します。

Enhanced

NetworkType

string

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

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

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

internet

RegionId

string

NAT ゲートウェイインスタンスのリージョン ID。

cn-qingdao

EcsMetricEnabled

boolean

ゲートウェイトラフィックモニタリング特徴が有効かどうかを示します。有効な値:

  • true: ゲートウェイトラフィックモニタリング特徴が有効です。

  • false: ゲートウェイトラフィックモニタリング特徴が無効です。

true

RequestId

string

リクエスト ID。

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

Description

string

NAT ゲートウェイインスタンスの説明。

NAT

ExpiredTime

string

NAT ゲートウェイインスタンスの有効期限時間。

2021-12-26T12:20:20Z

ResourceGroupId

string

リソースグループの ID。

rg-bp67acfmxazb4ph****

NatGatewayId

string

NAT ゲートウェイインスタンスの ID。

ngw-bp1047e2d4z7kf2ki****

BusinessStatus

string

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

  • Normal: 法線。

  • FinancialLocked: 支払い遅延によるロック。

Normal

Name

string

NAT ゲートウェイインスタンスの名前。

abc

ForwardTable

object

DNAT テーブル情報。

ForwardTableId

string

DNAT テーブルの ID。

ftb-uf6gj3mhsg94qsqst****

ForwardEntryCount

integer

DNAT エントリの数。

1

SnatTable

object

SNAT テーブル情報。

SnatEntryCount

integer

SNAT エントリの数。

1

SnatTableId

string

SNAT テーブルの ID。

stb-SnatTableIds****

FullNatTable

object

FULLNAT テーブル情報。

FullNatEntryCount

integer

FULLNAT エントリの数。

1

FullNatTableId

string

FULLNAT テーブルの ID。

fulltb-gw88z7hhlv43rmb26****

BillingConfig

object

課金構成情報。

InternetChargeType

string

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

  • PayBySpec: 固定仕様による課金。

  • PayByLcu: 使用量による課金。

PayBySpec

AutoPay

string

自動支払いが有効かどうかを示します。InstanceChargeType の値が PrePaid の場合、以下の値が返されます:

  • false: 自動支払いが無効です。注文生成後、注文センターに移動して支払いを完了してください。

  • true: 自動支払いが有効です。注文は自動的に支払われます。

InstanceChargeType の値が PostPaid の場合、空の値が返されます。

false

Spec

string

インターネット NAT ゲートウェイインスタンスのスペック。InternetChargeType が PayBySpec の場合、以下の値が返されます:

  • Small: small。

  • Middle: 中間。

  • Large: large。 InternetChargeType が PayByLcu の場合、空の値が返されます。

Small

InstanceChargeType

string

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

PostPaid

PrivateInfo

object

NAT ゲートウェイインスタンスのプライベートネットワーク情報。

MaxBandwidth

integer

帯域幅の最大値。単位: Mbit/s。

5120

VswitchId

string

NAT ゲートウェイインスタンスが属する vSwitch の ID。

vsw-bp1s2laxhdf9ayjbo***

PrivateIpAddress

string

非公開 IP アドレス。

192.168.XX.XX

IzNo

string

NAT ゲートウェイインスタンスが属するゾーン。

cn-qingdao-b

EniInstanceId

string

Elastic Network Interface (ENI) ネットワークインターフェースコントローラー (NIC) のインスタンス ID。

eni-bp1cmgtoaka8vfyg****

DeletionProtectionInfo

object

削除保護情報。

Enabled

boolean

削除保護が有効かどうかを示します。

  • true: 削除保護が有効です。

  • false: 削除保護が無効です。

true

IpList

array<object>

インターネット NAT ゲートウェイに関連付けられた EIP のリスト。

object

インターネット NAT ゲートウェイに関連付けられた EIP のリスト。

UsingStatus

string

インターネット NAT ゲートウェイインスタンスにバインドされた EIP の関連付けステータス。

  • idle: アイドル。EIP は SNAT エントリまたは DNAT エントリに関連付けられていません。

  • UsedBySnatTable: EIP は SNAT エントリに関連付けられています。

  • UsedByForwardTable: EIP は DNAT エントリに関連付けられています。

idle

IpAddress

string

EIP の IP アドレス。

116.33.XX.XX

AllocationId

string

EIP のインスタンス ID。

eip-bp13e9i2qst4g6jzi****

PrivateLinkEnabled

boolean

非公開接続性がサポートされているかどうかを示します。有効な値:

  • true: 非公開接続性がサポートされています。

  • false: 非公開接続性はサポートされていません。

true

PrivateLinkMode

string

非公開接続性サービスの変換モード。有効な値:

  • FullNat: FULLNAT モード。

  • Geneve: Geneve モード。

FullNat

EnableSessionLog

boolean

セッションログが有効かどうかを示します。有効な値:

  • true: セッションログが有効です。

  • false: セッションログが無効です。

true

LogDelivery

object

セッションログ構成情報。

LogDeliveryType

string

セッションログ log delivery の送信先タイプ。有効な値: sls: Alibaba Cloud Simple Log Service (SLS)。

sls

LogDestination

string

セッションログの書き込み先の送信先アドレス。

acs:log:cn-hangzhou:0000:project/nat_session_log_project/logstore/session_log_test

DeliveryStatus

string

セッションログ書き込みのステータス。有効な値:

  • Succsess: 成功。

  • Failure: 失敗。

Failure

DeliverLogsErrorMessage

string

セッションログ書き込み失敗のエラーメッセージ。

LogStoreNotExist: logstore 会話_ログ_test does not exist

AccessMode

object

VPC NAT Gateway へのリバースアクセスのアクセスモード。

ModeValue

string

アクセスモードの値。有効な値:

  • route: ルートモード。

  • tunnel: トンネルモード。

ルート

TunnelType

string

トンネルモードのタイプ。有効な値:

  • geneve: Geneve タイプ。

geneve

AvailabilityMode

string

例

成功レスポンス

JSONJSON

{
  "VpcId": "vpc-bp15zckdt37pq72z****",
  "CreationTime": "2021-12-08T12:20:20Z",
  "Status": "Available",
  "NatType": "Enhanced",
  "NetworkType": "internet",
  "RegionId": "cn-qingdao",
  "EcsMetricEnabled": true,
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "Description": "NAT",
  "ExpiredTime": "2021-12-26T12:20:20Z",
  "ResourceGroupId": "rg-bp67acfmxazb4ph****",
  "NatGatewayId": "ngw-bp1047e2d4z7kf2ki****",
  "BusinessStatus": "Normal",
  "Name": "abc",
  "ForwardTable": {
    "ForwardTableId": "ftb-uf6gj3mhsg94qsqst****",
    "ForwardEntryCount": 1
  },
  "SnatTable": {
    "SnatEntryCount": 1,
    "SnatTableId": "stb-SnatTableIds****"
  },
  "FullNatTable": {
    "FullNatEntryCount": 1,
    "FullNatTableId": "fulltb-gw88z7hhlv43rmb26****"
  },
  "BillingConfig": {
    "InternetChargeType": "PayBySpec",
    "AutoPay": "false",
    "Spec": "Small",
    "InstanceChargeType": "PostPaid"
  },
  "PrivateInfo": {
    "MaxBandwidth": 5120,
    "VswitchId": "vsw-bp1s2laxhdf9ayjbo***",
    "PrivateIpAddress": "192.168.XX.XX",
    "IzNo": "cn-qingdao-b",
    "EniInstanceId": "eni-bp1cmgtoaka8vfyg****"
  },
  "DeletionProtectionInfo": {
    "Enabled": true
  },
  "IpList": [
    {
      "UsingStatus": "idle",
      "IpAddress": "116.33.XX.XX",
      "AllocationId": "eip-bp13e9i2qst4g6jzi****"
    }
  ],
  "PrivateLinkEnabled": true,
  "PrivateLinkMode": "FullNat",
  "EnableSessionLog": true,
  "LogDelivery": {
    "LogDeliveryType": "sls",
    "LogDestination": "acs:log:cn-hangzhou:0000:project/nat_session_log_project/logstore/session_log_test",
    "DeliveryStatus": "Failure",
    "DeliverLogsErrorMessage": "LogStoreNotExist: logstore session_log_test が存在しません"
  },
  "AccessMode": {
    "ModeValue": "route",
    "TunnelType": "geneve"
  },
  "AvailabilityMode": ""
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

404 InvalidRegionId.NotFound The specified RegionId does not exist in our records.

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

変更履歴

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