调用DescribeVpnGateways接口查询已创建的VPN网关。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeVpnGateways |
要执行的操作。 取值:DescribeVpnGateways。 |
RegionId | String | 是 | cn-hangzhou |
VPN网关所在的地域。 您可以通过调用DescribeRegions接口获取地域ID。 |
BusinessStatus | String | 否 | Normal |
VPN网关的付费状态。 取值: Normal | FinancialLocked |
PageNumber | Integer | 否 | 1 |
列表的页码,默认值为1。 |
PageSize | Integer | 否 | 10 |
分页查询时每页的行数,最大值为50,默认值为10。 |
Status | String | 否 | init |
VPN网关的状态,取值:
|
VpcId | String | 否 | vpc-bp1ub1yt9cvakoelj**** |
VPN网关所属VPC的ID。 |
VpnGatewayId | String | 否 | vpn-bp1q8bgx4xnkm2ogj**** |
VPN网关的ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
VpnGateways |
VPN网关的详细信息。 |
||
VpnGatewayId | String | vpn-bp1q8bgx4xnkm2ogj**** |
VPN网关的ID。 |
VpcId | String | vpc-bp1ub1yt9cvakoelj**** |
VPN网关所属VPC的ID。 |
VSwitchId | String | vsw-bp1y9ovl1cu9ou4tv**** |
VPN网关所属交换机的ID。 |
InternetIp | String | 116.62.69.xxx |
VPN网关的公网IP。 |
CreateTime | Long | 1515383700000 |
VPN网关的创建时间。 |
EndTime | Long | 1518105600000 |
VPN网关的到期时间。 |
Spec | String | 5M |
VPN网关的带宽峰值。 |
Name | String | test |
VPN网关的名称。 |
Description | String | test |
VPN网关的描述。 |
Status | String | active |
VPN网关的状态。 |
BusinessStatus | String | Normal |
VPN网关的状态。 |
ChargeType | String | Prepay |
计费类型。 |
IpsecVpn | String | enable |
是否开启了IPSec-VPN功能。 |
SslMaxConnections | Long | 5 |
允许连接的最大SSL-VPN客户端。 |
SslVpn | String | enable |
是否开启了SSL-VPN功能。 |
Tag | String | 1 |
标签。 |
TotalCount | Integer | 1 |
列表条条目数。 |
PageNumber | Integer | 1 |
当前页码。 |
PageSize | Integer | 10 |
当前分页包含的条目数。 |
RequestId | String | DF11D6F6-E35A-41C3-9B20-6FC8A901FE65 |
请求ID。 |
示例
请求示例
https://vpc.aliyuncs.com/?Action=DescribeVpnGateways
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
<DescribeVpnGatewaysResponse>
<PageNumber>1</PageNumber>
<TotalCount>1</TotalCount>
<PageSize>10</PageSize>
<VpnGateways>
<VpnGateway>
<Status>active</Status>
<VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj****</VpnGatewayId>
<BusinessStatus>Normal</BusinessStatus>
<Spec>5M</Spec>
<CreateTime>1492753580000</CreateTime>
<InternetIp>116.62.69.xxx</InternetIp>
<EndTime>1495382400000</EndTime>
<VSwitchId>vsw-bp1y9ovl1cu9ou4tv****</VSwitchId>
<VpcId>vpc-bp1ub1yt9cvakoelj****</VpcId>
</VpnGateway>
</VpnGateways>
<RequestId>DF11D6F6-E35A-41C3-9B20-6FC8A901FE65</RequestId>
</DescribeVpnGatewaysResponse>
JSON
格式
{
"PageNumber":1,
"TotalCount":1,
"PageSize":10,
"VpnGateways":{
"VpnGateway":[
{
"Status":"active",
"VpnGatewayId":"vpn-bp1q8bgx4xnkm2ogj****",
"Spec":"5M",
"BusinessStatus":"Normal",
"CreateTime":1492753580000,
"InternetIp":"116.62.69.xxx",
"EndTime":1495382400000,
"VSwitchId":"vsw-bp1y9ovl1cu9ou4tv****",
"VpcId":"vpc-bp1ub1yt9cvakoelj****"
}
]
},
"RequestId":"B2CD1315-CA2B-47B1-9DA5-8F1D69C48E82"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | Forbbiden.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. | 您没有权限操作指定资源,请提交工单咨询。 |
访问错误中心查看更多错误码。