调用DescribeVpnGateways接口查询指定地域下已创建的VPN网关的信息

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeVpnGateways	系统规定参数。取值：DescribeVpnGateways。
RegionId	String	是	cn-zhangjiakou	VPN网关所在的地域ID。您可以通过调用DescribeRegions接口获取地域ID。
VpcId	String	否	vpc-bp1m3i0kn1nd4wiw9****	VPN网关所属专有网络VPC（Virtual Private Cloud）的ID。
VpnGatewayId	String	否	vpn-bp17lofy9fd0dnvzv****	VPN网关的ID。
Status	String	否	active	VPN网关的状态。取值： init ：初始化。 provisioning ：准备中。 active ：正常。 updating ：更新中。 deleting ：删除中。
BusinessStatus	String	否	Normal	VPN网关的付费状态。取值： Normal：正常。 FinancialLocked：欠费锁定。
PageNumber	Integer	否	1	列表的页码。默认值：1。
PageSize	Integer	否	10	分页查询时每页的条目数。取值范围：1~50。默认值：10。
IncludeReservationData	Boolean	否	true	是否包含未生效的订购数据。取值： false（默认值）：不包含未生效的订购数据。 true：包含未生效的订购数据。
Tag.N.Key	String	否	FinanceDept	标签的标签键。一旦输入该值，则不允许为空字符串。最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。一次最多支持输入20个标签键。
Tag.N.Value	String	否	FinanceJoshua	标签的标签值。标签值最多支持128个字符，可以为空字符串，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。一个标签键对应一个标签值。一次最多支持输入20个标签值。

返回数据


名称	类型	示例值	描述
PageSize	Integer	10	分页查询时每页的条目数。
RequestId	String	DF11D6F6-E35A-41C3-9B20-6FC8A901FE65	请求ID。
PageNumber	Integer	1	列表的页码。
TotalCount	Integer	1	列表条目数。
VpnGateways	Array of VpnGateway		VPN网关信息列表。
VpnGateway
VpnType	String	Normal	VPN网关类型。 Normal：普通型。 NationalStandard：国密型。
Status	String	active	VPN网关的状态。 init ：初始化。 provisioning ：准备中。 active ：正常。 updating ：更新中。 deleting ：删除中。
VpcId	String	vpc-bp1m3i0kn1nd4wiw9****	VPN网关所属VPC的ID。
SslMaxConnections	Long	5	VPN网关SSL连接数的规格。
Spec	String	5M	VPN网关的带宽峰值。M表示单位Mbps。
InternetIp	String	47.12.XX.XX	VPN网关的公网IP地址。
CreateTime	Long	1515383700000	创建VPN网关的时间戳。单位：毫秒。时间戳的格式采用Unix时间戳，表示从格林威治时间1970年01月01日00时00分00秒至创建VPN网关实例时的总时长。
AutoPropagate	Boolean	true	是否将BGP路由自动传播到VPC。 true：自动传播。 false：不自动传播。
ChargeType	String	中国站示例值：Prepay，国际站示例值：POSTPAY	VPN网关的付费类型。仅取值：Prepay，包年包月。
VpnGatewayId	String	vpn-bp17lofy9fd0dnvzv****	VPN网关的ID。
Tag	String	{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"转发1.3.7\",\"VpnVersion\":\"v1.2.4\"}	系统自动生成的VPN网关标签。 VpnEnableBgp：表示VPN网关是否支持BGP功能。 true：支持。 false：不支持。 VisuallySsl：表示VPN网关是否支持查看SSL客户端的连接信息。 true：支持。 false：不支持。 PbrPriority：表示VPN网关是否支持为策略路由配置策略优先级。 true：支持。 false：不支持。 VpnNewImage：表示VPN网关是否为新型VPN网关。 true：是。 false：否。 description：表示VPN网关的描述信息，仅供系统内部使用。 VpnVersion：表示VPN网关的版本号。
IpsecVpn	String	enable	VPN网关是否开启了IPsec-VPN功能。 enable：已开启。 disable：未开启。
EndTime	Long	1518105600000	VPN网关到期时间戳。单位：毫秒。时间戳的格式采用Unix时间戳，表示从格林威治时间1970年01月01日00时00分00秒至VPN网关实例到期时的总时长。
VSwitchId	String	vsw-bp15lbk8sgtr6r5b0****	VPN网关所属交换机的ID。
Description	String	test	VPN网关的描述信息。
EnableBgp	Boolean	true	VPN网关BGP功能的开启状态。 true：已开启。 false：未开启。
BusinessStatus	String	Normal	VPN网关的付费状态。 Normal：正常。 FinancialLocked：欠费锁定。
SslVpn	String	enable	VPN网关是否开启了SSL-VPN功能。 enable：已开启。 disable：未开启。
Name	String	test	VPN网关的名称。
NetworkType	String	public	VPN网关的网络类型。 public：公网VPN网关。 private：私网VPN网关。
Tags	Array of Tag		VPN网关绑定的标签列表。
Tag
Key	String	FinanceDept	标签键。
Value	String	FinanceJoshua	标签值。
ReservationData	Object		未生效的订购数据。说明仅 IncludeReservationData传入 true才会返回该组参数。
Status	String	1	未生效订单状态。 1：表示续费或续费变配的订单未生效。 2：表示临时升配的订单已生效。在到达还原时间后，系统会将VPN网关规格恢复到临时升配前的规格。此时ReservationIpsec、ReservationMaxConnections、ReservationSpec、ReservationSsl表示为VPN网关临时升配前的规格。
ReservationOrderType	String	TEMP_UPGRADE	未生效订单类型。 RENEWCHANGE：续费变配。 TEMP_UPGRADE：临时升配。 RENEW：续费。
ReservationIpsec	String	enable	未生效订单IPsec-VPN功能开启状态。 enable：已开启。 disable：未开启。
ReservationSpec	String	5	未生效订单的带宽规格。单位：Mbps。
ReservationSsl	String	enable	未生效订单SSL-VPN功能开启状态。 enable：已开启。 disable：未开启。
ReservationMaxConnections	Integer	5	未生效订单SSL-VPN并发连接用户数的规格。
ReservationEndTime	String	2021-07-20T16:00:00Z	如果未生效订单类型为TEMP_UPGRADE（临时升配）时，该参数表示为临时升配的还原时间。如果未生效订单类型为RENEWCHANGE（续费变配）或RENEW（续费）时，该参数表示为续费或续费变配开始生效时间。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVpnGateways
&RegionId=cn-zhangjiakou
&VpcId=vpc-bp1m3i0kn1nd4wiw9****
&VpnGatewayId=vpn-bp17lofy9fd0dnvzv****
&Status=init
&BusinessStatus=Normal
&PageNumber=1
&PageSize=10
&IncludeReservationData=true
&Tag.1.Key=FinanceDept
&Tag.1.Value=FinanceJoshua
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVpnGatewaysResponse>
    <PageSize>10</PageSize>
    <RequestId>DF11D6F6-E35A-41C3-9B20-6FC8A901FE65</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <VpnGateways>
        <VpnType>Normal</VpnType>
        <Status>Active</Status>
        <VpcId>vpc-bp1m3i0kn1nd4wiw9****</VpcId>
        <SslMaxConnections>5</SslMaxConnections>
        <Spec>5M</Spec>
        <InternetIp>47.12.XX.XX</InternetIp>
        <CreateTime>1515383700000</CreateTime>
        <AutoPropagate>true</AutoPropagate>
        <ChargeType>中国站示例值：Prepay，国际站示例值：POSTPAY</ChargeType>
        <VpnGatewayId>vpn-bp17lofy9fd0dnvzv****</VpnGatewayId>
        <Tag>{"VpnEnableBgp":"true","VisuallySsl":"true","PbrPriority":"true","VpnNewImage":"true","description":"转发1.3.7","VpnVersion":"v1.2.4"}</Tag>
        <IpsecVpn>enable</IpsecVpn>
        <EndTime>1518105600000</EndTime>
        <VSwitchId>vsw-bp15lbk8sgtr6r5b0****</VSwitchId>
        <Description>test</Description>
        <EnableBgp>true</EnableBgp>
        <BusinessStatus>Normal</BusinessStatus>
        <SslVpn>enable</SslVpn>
        <Name>test</Name>
        <NetworkType>public</NetworkType>
        <Tags>
            <Key>FinanceDept</Key>
            <Value>FinanceJoshua</Value>
        </Tags>
        <ReservationData>
            <Status>1</Status>
            <ReservationOrderType>TEMP_UPGRADE</ReservationOrderType>
            <ReservationIpsec>enable</ReservationIpsec>
            <ReservationSpec>5</ReservationSpec>
            <ReservationSsl>enable</ReservationSsl>
            <ReservationMaxConnections>5</ReservationMaxConnections>
            <ReservationEndTime>2021-07-20T16:00:00Z</ReservationEndTime>
        </ReservationData>
    </VpnGateways>
</DescribeVpnGatewaysResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "VpnGateways" : [ {
    "VpnType" : "Normal",
    "Status" : "Active",
    "VpcId" : "vpc-bp1m3i0kn1nd4wiw9****",
    "SslMaxConnections" : 5,
    "Spec" : "5M",
    "InternetIp" : "47.12.XX.XX",
    "CreateTime" : 1515383700000,
    "AutoPropagate" : true,
    "ChargeType" : "中国站示例值：Prepay，国际站示例值：POSTPAY",
    "VpnGatewayId" : "vpn-bp17lofy9fd0dnvzv****",
    "Tag" : "{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"转发1.3.7\",\"VpnVersion\":\"v1.2.4\"}",
    "IpsecVpn" : "enable",
    "EndTime" : 1518105600000,
    "VSwitchId" : "vsw-bp15lbk8sgtr6r5b0****",
    "Description" : "test",
    "EnableBgp" : true,
    "BusinessStatus" : "Normal",
    "SslVpn" : "enable",
    "Name" : "test",
    "NetworkType" : "public",
    "Tags" : [ {
      "Key" : "FinanceDept",
      "Value" : "FinanceJoshua"
    } ],
    "ReservationData" : {
      "Status" : "1",
      "ReservationOrderType" : "TEMP_UPGRADE",
      "ReservationIpsec" : "enable",
      "ReservationSpec" : "5",
      "ReservationSsl" : "enable",
      "ReservationMaxConnections" : 5,
      "ReservationEndTime" : "2021-07-20T16:00:00Z"
    }
  } ]
}

错误码


HttpCode	错误码	错误信息	描述
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.	指定的参数TagKey不合规范。
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	指定的参数TagValue不合规范。
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	指定的参数TagKey重复。
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.	您没有权限操作指定资源，请申请权限后再操作。

访问错误中心查看更多错误码。