DescribeNatGateways - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

説明

この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに Vpc(2016-04-28) - DescribeNatGateways への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

今すぐお試しください

この 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

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	NAT ゲートウェイが設置されているリージョンの ID です。DescribeRegions オペレーションを呼び出して、最新のリージョンリストを取得できます。
NatGatewayId	string	任意	NAT ゲートウェイの ID です。
VpcId	string	任意	NAT ゲートウェイが設置されている VPC の ID です。
PageNumber	integer	任意	表示するページ番号です。ページ番号は 1 から始まります。デフォルト値：1。
PageSize	integer	任意	ページあたりのエントリ数です。有効な値：1～100。デフォルト値：10。

レスポンスフィールド

フィールド	型	説明	例
	object	返されたデータ。
PageSize	integer	ページあたりのエントリ数。
RequestId	string	リクエスト ID。
PageNumber	integer	ページ番号。
TotalCount	integer	返されたエントリの総数。
NatGateways	object	NAT ゲートウェイ詳細のコンテナー。
NatGateway	array<object>	NAT ゲートウェイオブジェクトのリスト。
	array<object>	NAT ゲートウェイの詳細。
Status	string	NAT ゲートウェイのステータス。有効な値： `Available`、`Pending`、`Deleting`。
CreationTime	string	NAT ゲートウェイが作成された時刻。時刻は UTC で表され、`YYYY-MM-DDThh:mm:ssZ` 形式です。
VpcId	string	NAT ゲートウェイが属する VPC の ID。
Spec	string	NAT ゲートウェイの仕様。有効な値： `Small`、`Middle`、`Large`。
Description	string	NAT ゲートウェイの説明。
NatGatewayId	string	NAT ゲートウェイの ID。
BusinessStatus	string	NAT ゲートウェイのビジネスステータス。有効な値： `Normal` (正常)、`FinancialLocked` (延滞によるロック)。
Name	string	NAT ゲートウェイの名前。
InstanceChargeType	string	NAT ゲートウェイの請求方法。値は `PostPaid` で、従量課金方式を示します。
RegionId	string	NAT ゲートウェイがデプロイされているリージョンの ID。
ForwardTableIds	object	転送テーブルの ID。
ForwardTableId	array	転送テーブル ID のリスト。
	string	転送テーブルの ID。
BandwidthPackageIds	object	帯域幅パッケージの ID。
BandwidthPackageId	array	帯域幅パッケージ ID のリスト。
	string	帯域幅パッケージの ID。

例

成功レスポンス

JSONJSON

{
  "PageSize": 0,
  "RequestId": "",
  "PageNumber": 0,
  "TotalCount": 0,
  "NatGateways": {
    "NatGateway": [
      {
        "Status": "",
        "CreationTime": "",
        "VpcId": "",
        "Spec": "",
        "Description": "",
        "NatGatewayId": "",
        "BusinessStatus": "",
        "Name": "",
        "InstanceChargeType": "",
        "RegionId": "",
        "ForwardTableIds": {
          "ForwardTableId": [
            ""
          ]
        },
        "BandwidthPackageIds": {
          "BandwidthPackageId": [
            ""
          ]
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidAliuid	User Id is not valid.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.

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

変更履歴

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