edit-icon download-icon

DescribeVpnGateway

最終更新日: May 05, 2018

説明

VPN Gateway の詳細情報を照会します。

リクエストパラメーター

名前 必須かどうか 説明
Action String はい

実行するアクション。

有効値:DescribeVpnGateway

RegionId String はい

VPN Gateway のリージョン。

リージョン ID を取得するには、DescribeRegions API を呼び出します。

VpnGatewayId String はい VPN Gateway の ID。

レスポンスパラメーター

名前 説明
RequestId String リクエストの ID。
VpnGatewayId String VPN Gateway の ID。
VpcId String VPN Gateway が属する VPC の ID。
VSwitchId String VPN Gateway が属する VSwitch の ID。
InternetIp String パブリック IP アドレス。
CreateTime Long VPN Gateway の作成時間。
EndTime Long VPN Gateway の有効期限。
Spec String VPN Gateway の仕様。
Name String VPN Gateway の名前。
Description String VPN Gateway の説明。
Status String VPN Gateway のステータス。
BusinessStatus String VPN Gateway のビジネスステータス。

エラーコード

VPC API Error Center」をご参照ください。

リクエストの例

  1. https://vpc.aliyuncs.com/?Action=DescribeVpnGateway
  2. &RegionID=cn-beijing
  3. &VpnGatewayId=vpn-bp1q8bgx4xnkm2ogj0fiu
  4. &<CommonParameters>

レスポンスの例

XML 形式

  1. <DescribeVpnGatewayResponse>
  2. <Status>active</Status>
  3. <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj0fiu</VpnGatewayId>
  4. <Spec>5M</Spec>
  5. <BusinessStatus>Normal</BusinessStatus>
  6. <RequestId>98C99F30-A3D2-42E1-AC75-0C882FBE92F7</RequestId>
  7. <CreateTime>1492753580000</CreateTime>
  8. <InternetIp>116.62.69.64</InternetIp>
  9. <EndTime>1495382400000</EndTime>
  10. <VSwitchId>vsw-bp1y9ovl1cu9ou4tvma0l</VSwitchId>
  11. <VpcId>vpc-bp1ub1yt9cvakoelj1y9c</VpcId>
  12. </DescribeVpnGatewayResponse>

JSON 形式

  1. {
  2. "Status": "active",
  3. "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj0fiu",
  4. "BusinessStatus": "Normal",
  5. "Spec": "5M",
  6. "CreateTime": 1492753580000,
  7. "RequestId": "E98A9651-7098-40C7-8F85-C818D1EBBA85",
  8. "InternetIp": "116.62.69.64",
  9. "EndTime": 1495382400000,
  10. "VSwitchId": "vsw-bp1y9ovl1cu9ou4tvma0l",
  11. "VpcId": "vpc-bp1ub1yt9cvakoelj1y9c"
  12. }