全部产品
专有网络 VPC

查询VPN网关列表

更新时间:2017-06-07 13:26:11   分享:   

描述

此接口为查询VPN实例列表接口,返参中会包含每个VPN实例的详细信息

请求参数

参数名 类型 是否必须 描述
Action String 系统规定参数,取值:DescribeVpnGateways
RegionId String 指定查询VPNGateways的地域
VpcId String 过滤类参数。如指定该参数,只返回关联VPC的VPNGateway的结果,不指定则不过滤
Status String 过滤类参数。如指定该参数,只返回指定Status的结果,不指定该参数则为不过滤。可选值:
{“init”,”provisioning”,”active”,”updating”,”upgrading”,”deleting”}
BusinessStatus String 过滤类参数。如指定该参数,只返回指定BusinessStatus的结果,不指定该参数则为不过滤。可选值:{“Normal”,”FinancialLocked”}
PageNumber Integer 实例状态列表的页码,起始值为 1,默认值为 1
PageSize Integer 分页查询时设置的每页行数,最大值 50 行,默认为 10

返回参数

参数名 类型 描述
VpnGateways List VPNGateway列表
TotalCount Integer 列表条条目数
PageNumber Integer 当前页码
PageSize Integer 当前分页包含多少条目

VPNGateway 列表

名称 类型 描述
VpnGatewayId String VPNGateway唯一标识
VpcId String VPNGateway关联的VPC
VSwitchId String VPNGateway关联的VSwitch
InternetIp String 公网ip
CreateTime Long VPNGateway 创建时间
EndTime Long VPNGateway到期时间
Spec String VPNGateway的带宽规格,
规格代码为 5M 10M 20M 等
Name String VpnGateway实例名称
Description String VpnGateway实例描述信息
Status String init, provisioning, active, updating, upgrading, deleting, deleted
VPN-GW的状态复用底层NFV Service的状态机,一期不允许处于ing状态的情况下再次进行配置,必须等待上一次的配置完成
BusinessStatus String Normal, FinancialLocked

错误码

ErrCode Message Http Status 描述
InvalidRegionId.NotFound Specified region is not found during access authentication. 404 指定的 Region 不存在
InvalidParameter The specified parameter pageSize is not valid 400 PageSize 非法
InvalidParameter The specified parameter pageNumber is not valid 400 PageNumber非法

示例

请求示例

  1. https://vpc.aliyuncs.com/?Action=DescribeVpnGateways
  2. &RegionID=cn-hangzhou
  3. &<公共请求参数>

返回示例

XML格式

  1. <DescribeVpnGatewaysResponse>
  2. <PageNumber>1</PageNumber>
  3. <TotalCount>1</TotalCount>
  4. <PageSize>10</PageSize>
  5. <VpnGateways>
  6. <VpnGateway>
  7. <Status>active</Status>
  8. <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj0fiu</VpnGatewayId>
  9. <BusinessStatus>Normal</BusinessStatus>
  10. <Spec>5M</Spec>
  11. <CreateTime>1492753580000</CreateTime>
  12. <InternetIp>116.62.69.64</InternetIp>
  13. <EndTime>1495382400000</EndTime>
  14. <VSwitchId>vsw-bp1y9ovl1cu9ou4tvma0l</VSwitchId>
  15. <VpcId>vpc-bp1ub1yt9cvakoelj1y9c</VpcId>
  16. </VpnGateway>
  17. </VpnGateways>
  18. <RequestId>DF11D6F6-E35A-41C3-9B20-6FC8A901FE65</RequestId>
  19. </DescribeVpnGatewaysResponse>

JSON格式

  1. {
  2. "PageNumber":1,
  3. "TotalCount":1,
  4. "VpnGateways":{
  5. "VpnGateway":[
  6. {
  7. "Status":"active",
  8. "VpnGatewayId":"vpn-bp1q8bgx4xnkm2ogj0fiu",
  9. "BusinessStatus":"Normal",
  10. "Spec":"5M",
  11. "CreateTime":1492753580000,
  12. "InternetIp":"116.62.69.64",
  13. "EndTime":1495382400000,
  14. "VSwitchId":"vsw-bp1y9ovl1cu9ou4tvma0l",
  15. "VpcId":"vpc-bp1ub1yt9cvakoelj1y9c"
  16. }
  17. ]
  18. },
  19. "PageSize":10,
  20. "RequestId":"B2CD1315-CA2B-47B1-9DA5-8F1D69C48E82"
  21. }
本文导读目录
本文导读目录
以上内容是否对您有帮助?