DescribeCustomerGateways - VPN Gateway - Alibaba Cloud ドキュメントセンター

カスタマーゲートウェイの情報を照会します。

今すぐお試しください

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

list

CustomerGateway。

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

CustomerGateway。

acs:vpc:{#regionId}:{#accountId}:customergateway/{#CustomerGatewayId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	カスタマーゲートウェイのリージョン ID。 DescribeRegions を呼び出してリージョン ID をクエリできます。	cn-shanghai
CustomerGatewayId	string	任意	カスタマーゲートウェイのインスタンス ID。説明カスタマーゲートウェイのインスタンス ID を指定しない場合、システムはデフォルトで現在のリージョン内のすべてのカスタマーゲートウェイの情報を照会します。	cgw-bp1pvpl9r9adju6l5****
PageNumber	integer	任意	リストのページ番号。デフォルト値: 1。	1
PageSize	integer	任意	ページングクエリにおける 1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10。	10
Tag	array<object>	任意	カスタマーゲートウェイにバインドされているタグのリスト。
	object	任意	タグ情報。
Key	string	任意	タグキー。このパラメーターを指定する場合、値は空文字列にできません。タグキーの長さは最大 64 文字で、`aliyun` または `acs:` で始まることはできません。また、`http://` または `https://` を含めることはできません。一度に最大 20 個のタグキーを指定できます。	TagKey
Value	string	任意	タグ値。タグ値の長さは最大 128 文字で、空文字列を指定できます。`aliyun` または `acs:` で始まることはできず、`http://` または `https://` を含めることはできません。各タグキーは 1 つのタグ値に対応します。一度に最大 20 個のタグ値を指定できます。	TagValue
ResourceGroupId	string	任意	カスタマーゲートウェイが属するリソースグループの ID。 ListResourceGroups を呼び出してリソースグループ ID をクエリできます。	rg-acfmzs372yg****

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
PageSize	integer	ページングクエリにおける 1 ページあたりのエントリ数。	10
RequestId	string	リクエスト ID。	E82612A9-CB90-4D7E-B394-1DB7F6509B29
PageNumber	integer	リストのページ番号。	1
TotalCount	integer	リスト内のエントリの総数。	1
CustomerGateways	object
CustomerGateway	array<object>	カスタマーゲートウェイ情報のリスト。
	array<object>	カスタマーゲートウェイの情報。
IpAddress	string	オンプレミスデータセンターのゲートウェイデバイスの IP アドレス。	139.32.XX.XX
Asn	integer	オンプレミスデータセンターのゲートウェイデバイスの自律システム番号。	65530
Description	string	カスタマーゲートウェイの説明。	desctest
CustomerGatewayId	string	カスタマーゲートウェイのインスタンス ID。	cgw-bp1pvpl9r9adju6l5****
CreateTime	integer	カスタマーゲートウェイが作成されたタイムスタンプ。単位: ミリ秒。タイムスタンプは UNIX 時間フォーマットに従い、1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) からカスタマーゲートウェイが作成された時点までに経過したミリ秒の総数を表します。	1492747187000
Name	string	カスタマーゲートウェイの名前。	nametest
AuthKey	string	オンプレミスデータセンターのゲートウェイデバイスの BGP ルーティングプロトコルの認証キー。	AuthKey****
Tags	object
Tag	array<object>	カスタマーゲートウェイにバインドされているタグのリスト。
	object	タグ情報。
Key	string	タグキー。	TagKey
Value	string	タグ値。	TagValue
ResourceGroupId	string	カスタマーゲートウェイが属するリソースグループの ID。 ListResourceGroups を呼び出してリソースグループ情報をクエリできます。	rg-acfmzs372yg****

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "E82612A9-CB90-4D7E-B394-1DB7F6509B29",
  "PageNumber": 1,
  "TotalCount": 1,
  "CustomerGateways": {
    "CustomerGateway": [
      {
        "IpAddress": "139.32.XX.XX",
        "Asn": 65530,
        "Description": "desctest",
        "CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5****",
        "CreateTime": 1492747187000,
        "Name": "nametest",
        "AuthKey": "AuthKey****",
        "Tags": {
          "Tag": [
            {
              "Key": "TagKey",
              "Value": "TagValue"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmzs372yg****"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	タグのリソースが重複しています。
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	タグの数が上限を超えています。
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	指定された TagValue パラメーターが無効です。
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.	指定された TagKey パラメーターが無効です。
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	指定された TagKey パラメーターが重複しています。
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.
403	Forbidden	User not authorized to operate on the specified resource.	EIP が現在の呼び出し元に属していません。この EIP を操作する権限があるかどうかを確認してください。

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

変更履歴

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