edit-icon download-icon

DescribeVPNGateway

Last Updated: Apr 12, 2018

Description

Query the detailed information of a VPN gateway.

Request parameters

Name Type Required Description
Action String Yes

The action to perform.

Valid value: DescribeVpnGateway

RegionId String Yes

The region of the VPN gateway.

You can obtain the region ID by calling the DescribeRegions API.

VpnGatewayId String Yes The ID of the VPN gateway.

Response parameters

Name Type Description
RequestId String The ID of the request.
VpnGatewayId String The ID of the VPN gateway.
VpcId String The ID of the VPC to which the VPN gateway belongs.
VSwitchId String The ID of the VSwitch to which the VPN gateway belongs.
InternetIp String The public IP address.
CreateTime Long The creation time of the VPN gateway.
EndTime Long The expiration time of the VPN gateway.
Spec String The specification of the VPN gateway.
Name String The name of the VPN gateway.
Description String The description of the VPN gateway.
Status String The status of the VPN gateway.
BusinessStatus String The business status of the VPN gateway.

Error codes

See VPC API Error Center.

Examples

Request example

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

Response example

XML format

  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 format

  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. }
Thank you! We've received your feedback.