DescribeCustomerGateway - 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:DescribeCustomerGateway

get

*CustomerGateway。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	カスタマーゲートウェイのリージョン ID。 DescribeRegions を呼び出してリージョン ID をクエリできます。	cn-shanghai
CustomerGatewayId	string	必須	カスタマーゲートウェイのインスタンス ID。	cgw-bp1pvpl9r9adju6l5****

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
Asn	integer	オンプレミスデータセンターのゲートウェイデバイスの自律システム番号。	65535
RequestId	string	リクエスト ID。	A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2
IpAddress	string	オンプレミスデータセンターのゲートウェイデバイスの IP アドレス。	139.32.XX.XX
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

{
  "Asn": 65535,
  "RequestId": "A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2",
  "IpAddress": "139.32.XX.XX",
  "Description": "desctest",
  "CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5****",
  "CreateTime": 1492747187000,
  "Name": "nametest",
  "AuthKey": "AuthKey****",
  "Tags": {
    "Tag": [
      {
        "Key": "TagKey",
        "Value": "TagValue"
      }
    ]
  },
  "ResourceGroupId": "rg-acfmzs372yg****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	Forbidden.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 を操作する権限があるかどうかを確認してください。
404	InvalidCustomerGatewayInstanceId.NotFound	The specified customer gateway instance id does not exist.	指定されたカスタマーゲートウェイインスタンスが存在しません。カスタマーゲートウェイインスタンス ID が正しいかどうかを確認してください。

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

変更履歴

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