DescribeVpnGateways--VPN连接-火山引擎

文档中心

立即注册

导航

DescribeVpnGateways

最近更新时间：2024.11.11 16:58:04首次发布时间：2022.04.28 07:17:15

调用DescribeVpnGateways查询满足指定条件的VPN网关。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeVpnGateways	要执行的操作，取值：DescribeVpnGateways
Version	String	是	2020-04-01	API版本信息。
PageSize	Integer	否	20	查询结果的分页大小。最大值：100，默认值：20。
PageNumber	Integer	否	1	查询结果的页码。如需传入此参数，请传入非负整数。不传或传入0，则均默认为1。
VpnGatewayIds.N	List of String	否	VpnGatewayIds.1=vgw-3tehy14c6c0v**&VpnGatewayIds.2=vgw-fg655nh68**	VPN网关的ID。参数 - N：表示VPN网关ID的序号。多个ID之间用&分隔。
VpnGatewayName	String	否	VpnGateway-test	VPN网关的名称。
VpcId	String	否	vpc-3tijjfd0ul4bwbhc****	VPN网关所在VPC的ID。您可调用DescribeVpcs查询VPC的ID信息。
SubnetId	String	否	subnet-3tijjfftzh4bwbhc****	VPN网关所在子网的ID。您可调用DescribeSubnets查询子网的ID信息。
IpAddress	String	否	22.XX.XX.18	VPN网关的出口IP地址。
ProjectName	String	否	Project_1	VPN网关所属的项目。传入该字段，表示查询指定项目下的VPN网关实例。不传入该字段，表示查询所有项目的VPN网关实例。
TagFilters.N.Key	String	否	TagFilters.1.Key=k1	根据标签查询资源时指定的标签键。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用`&`分隔。不允许重复。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2	根据标签查询资源时指定的标签值。第一个N：表示标签键的序号，取值范围：1～10。第二个N：表示标签值的序号，取值范围：1～3，即同一标签键最多支持同时查询3个标签值。多个标签值之间用`&`分隔。如果传入该参数，则必须先传入`TagFilters.N.Key`。如果不传该参数仅传入`TagFilters.N.Key`，表示查询同一标签键下的所有标签值。传入空字符串时，表示查询标签值为空的标签。如果同一个`TagFilters.N.Key`传入多个`TagFilters.N.Values.N`，多个`TagFilters.N.Values.N`之间的关系为逻辑“或(OR)”。
IPsecEnabled	Boolean	否	true	IPSec连接功能的开启状态。 true：开启 false：未开启
SslEnabled	Boolean	否	false	SSL连接功能的开启状态。 true：开启 false：未开启
Status	String	否	Available	VPN网关的状态。 Creating: 创建中 Deleting: 删除中 Pending：配置中 Available：可用

返回数据

名称	类型	示例值	描述
RequestId	String	20220322145233010225243081016A****	请求ID。
PageSize	Integer	20	当前分页的行数。
PageNumber	Integer	1	当前页码。
TotalCount	Integer	33	符合查询条件的VPN网关总数。
VpnGateways	Array of struct	-	VPN网关信息集合，具体请见下表“VpnGateway”。

VpnGateway

名称	类型	示例值	描述
AccountId	String	20005****	VPN网关所属账户的ID。
VpnGatewayId	String	vgw-3tehy13n2l4c6c0v****	VPN网关的ID。
VpcId	String	vpc-1234567****	VPN网关所在VPC的ID。
SubnetId	String	subnet-3thgqai7my4e8i4****	VPN网关使用的端口所属子网的ID。
CreationTime	String	2021-04-09T08:36:47+08:00	创建VPN网关的时间。
UpdateTime	String	2021-04-10T08:36:47+08:00	更新VPN网关的时间。
VpnGatewayName	String	VpnGateway-test	VPN网关的名称。
IpAddress	String	202.XX.XX.19	VPN网关的IP地址。
Description	String	This is a sample description	VPN网关的描述。
Status	String	Available	VPN网关的状态。 Creating: 创建中 Deleting: 删除中 Pending：配置中 Available：可用
Bandwidth	Integer	20	VPN网关的带宽规格。
ConnectionCount	Integer	10	VPN网关关联的IPsec连接的数量。
RouteCount	Integer	20	VPN网关上的路由条目数量。
BillingType	Integer	1	VPN网关的计费类型。 1：包年包月。 2：按量计费（按固定配置）。
BusinessStatus	String	Normal	VPN网关的计费状态。 Normal: 正常。 FinancialLocked: 被锁定。
LockReason	String	unlock	VPN网关的锁定原因。 financial: 因欠费被锁定。 security: 因安全被锁定。 unlock ：未锁定。
ExpiredTime	String	2022-04-21 23:59:59	VPN网关的到期时间。
DeletedTime	String	2022-05-06 23:59:59	VPN网关的到期删除时间。
Tags	Array of struct	-	VPN网关已添加的全部标签信息。具体请参见下表“Tag”。
ProjectName	String	Project_1	VPN网关所属的项目。
IpsecEnabled	Boolean	true	IPSec连接功能是否开启。 true：开启 false：关闭
SslEnabled	Boolean	false	SSL连接功能是否开启。 true：开启 false：关闭
SslMaxConnections	Integer	10	SSL连接数规格。
OverdueTime	String	2023-08-07T23:23:23+08:00	资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值，否则均返回空值。
IsBlocked	Boolean	false	当前资源的状态是否被封禁。 true：封禁 false：未封禁
Asn	Integer	65534	VPN网关的ASN。

Tag

名称	类型	示例值	描述
Key	String	key1	标签键。
Value	String	value1	标签值。

请求示例

GET /?Action=DescribeVpnGateways&Version=2020-04-01&VpnGatewayIds.1=vgw-12bfa2du7fojk17q7y1rk****&PageNumber=1&PageSize=20 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220322145233010225243081016A****",
        "Action": "DescribeVpnGateways",
        "Version": "2020-04-01",
        "Service": "vpn",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20220322145233010225243081016A****",
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "VpnGateways": [
            {
                "AccountId":"210000****",
                "VpnGatewayId":"vgw-12bfa2du7fojk17q7y1rk****",
                "CreationTime":"2022-03-21T11:14:30+08:00",
                "UpdateTime":"2022-03-21T11:15:19+08:00",
                "VpnGatewayName":"test",
                "Description":"test",
                "Status":"Available",
                "VpcId":"vpc-12bhs1ivo6p6o17q7y2x3****",
                "SubnetId":"subnet-2fewbgn7jbk0059gp67ap****",
                "IpAddress":"10.XX.XX.93",
                "RouteCount":0,
                "ConnectionCount":0,
                "Bandwidth":5,
                "BusinessStatus":"Normal",
                "LockReason":"unlock",
                "BillingType":1,
                "ExpiredTime":"2022-04-21 23:59:59",
                "DeletedTime":"2022-05-06 23:59:59",
                "ProjectName":"Project_1", 
                "OverdueTime":"",
                "IpsecEnabled": true,
                "SslEnabled": false,
                "SslMaxConnections": 10,
                "IsBlocked": false,
                "Asn": 65534,  
                "Tags":[
                    {
                        "Key":"k1",
                        "Value":"v1"
                    },
                    {
                        "Key":"k2",
                        "Value":""
                    }
                ]
            }
        ]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	LimitExceeded.VpnGatewayId	You've reached the limit on the number of VPN gateway IDs that you can describe.	已达到可查询的VPN网关ID数量上限。
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签值数量的上限。
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。