You need to enable JavaScript to run this app.
导航
VPN连接
  • 文档首页
    • /
  • VPN连接

DescribeVpnGateways

最近更新时间：2024.04.18 17:23:56

首次发布时间：2022.04.28 07:17:15

我的收藏

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

调试

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

请求参数

名称类型是否必选示例值描述
ActionString是DescribeVpnGateways要执行的操作，取值：DescribeVpnGateways
VersionString是2020-04-01API版本信息。
PageSizeInteger否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之间用&分隔。
VpnGatewayNameString否VpnGateway-testVPN网关的名称。
VpcIdString否vpc-3tijjfd0ul4bwbhc****VPN网关所在VPC的ID。您可调用DescribeVpcs查询VPC的ID信息。
SubnetIdString否subnet-3tijjfftzh4bwbhc****VPN网关所在子网的ID。您可调用DescribeSubnets查询子网的ID信息。
IpAddressString否22.XX.XX.18VPN网关的出口IP地址。

ProjectName

String

否

Project_1

VPN网关所属的项目。

  • 传入该字段，表示查询指定项目下的VPN网关实例。
  • 不传入该字段，表示查询所有项目的VPN网关实例。

TagFilters.N.Key

String

否

TagFilters.1.Key=key1&TagFilters.2.Key=key2&TagFilters.3.Key=key3

云资源实例的标签键（Key）。

  • 参数 - N - 参数：表示标签的序号，取值范围：1、2、3、……、9、10，且N应按照连续的从小到大的顺序。
  • 多个标签键之间用&分隔。
  • 如果传入多个TagFilters.N.Key，多个TagFilters.N.Key之间的关系为逻辑“与（AND）”。

TagFilters.N.Values.N

String

否

TagFilters.1.Values.1=value1&TagFilters.2.Values.2=value2&TagFilters.3.Values.3=value3

云资源实例的标签值（Value）。

  • 参数 - N - 参数- N ：第一个N表示标签值对应标签键的序号，应与标签键TagFilters.N.Key的序号保持一致，取值范围：1、2、3、……、9、10，且N应按照连续的从小到大的顺序。第二个N表示标签值的序号，取值范围：1、2、3。
  • 可不传入Value，表示查询时对Value不作限制。
  • 如果传入的Value是空字符串，表示查询 Value 为空的标签。
  • 如果同一个TagFilters.N.Key传入多个TagFilters.N.Values.N，多个TagFilters.N.Values.N之间的关系为逻辑“或(OR)”。

IPsecEnabled

Boolean

否

true

IPSec连接功能的开启状态。

  • true：开启
  • false：未开启

SslEnabled

Boolean

否

false

SSL连接功能的开启状态。

  • true：开启
  • false：未开启

返回数据

名称类型
示例值
描述
RequestIdString20220322145233010225243081016A****请求ID。
PageSizeInteger20当前分页的行数。
PageNumberInteger1当前页码。
TotalCountInteger33符合查询条件的VPN网关总数。
VpnGatewaysArray of struct-VPN网关信息集合，具体请见下表“VpnGateway”。

VpnGateway

名称类型
示例值
描述
AccountIdString20005****VPN网关所属账户的ID。
VpnGatewayIdStringvgw-3tehy13n2l4c6c0v****VPN网关的ID。
VpcIdStringvpc-1234567****VPN网关所在VPC的ID。
SubnetIdStringsubnet-3thgqai7my4e8i4****VPN网关使用的端口所属子网的ID。
CreationTimeString2021-04-09T08:36:47+08:00创建VPN网关的时间。
UpdateTimeString2021-04-10T08:36:47+08:00更新VPN网关的时间。
VpnGatewayNameStringVpnGateway-testVPN网关的名称。
IpAddressString202.XX.XX.19VPN网关的IP地址。
DescriptionStringThis is a sample descriptionVPN网关的描述。

Status

String

Available

VPN网关的状态。

  • Creating: 创建中
  • Deleting: 删除中
  • Pending：配置中
  • Available：可用
BandwidthInteger20VPN网关的带宽规格。
ConnectionCountInteger10VPN网关关联的IPsec连接的数量。
RouteCountInteger20VPN网关上的路由条目数量。

BillingType

Integer

1

VPN网关的计费类型。

  • 1：包年包月。
  • 2：按量计费（按固定配置）。

BusinessStatus

String

Normal

VPN网关的计费状态。

  • Normal: 正常。
  • FinancialLocked: 被锁定。

LockReason

String

unlock

VPN网关的锁定原因。

  • financial: 因欠费被锁定。
  • security: 因安全被锁定。
  • unlock ：未锁定。
ExpiredTimeString2022-04-21 23:59:59VPN网关的到期时间。
DeletedTimeString2022-05-06 23:59:59VPN网关的到期删除时间。
TagsArray of struct-VPN网关已添加的全部标签信息。具体请参见下表“Tag”。
ProjectNameStringProject_1VPN网关所属的项目。

IpsecEnabled

Boolean

true

IPSec连接功能是否开启。

  • true：开启

  • false：关闭

SslEnabled

Boolean

false

SSL连接功能是否开启。

  • true：开启
  • false：关闭
SslMaxConnectionsInteger10SSL连接数规格。
OverdueTimeString2023-08-07T23:23:23+08:00资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值，否则均返回空值。

Tag

名称类型示例值描述
KeyStringkey1标签键。
ValueStringvalue1标签值。

请求示例

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, 
                "Tags":[
                    {
                        "Key":"k1",
                        "Value":"v1"
                    },
                    {
                        "Key":"k2",
                        "Value":""
                    }
                ]
            }
        ]
    }
}

错误码

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

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