You need to enable JavaScript to run this app.
导航
VPN连接
  • 文档首页
    • /VPN连接/API参考/VPN网关/DescribeVpnGatewayAttributes
DescribeVpnGatewayAttributes
最近更新时间：2024.09.06 08:00:06首次发布时间：2022.04.28 07:17:15
我的收藏

调用DescribeVpnGatewayAttributes查看指定VPN网关的信息。

调试

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

请求参数

名称类型是否必选示例值描述
ActionString是DescribeVpnGatewayAttributes要执行的操作，取值：DescribeVpnGatewayAttributes。
VersionString是2020-04-01API版本信息。
VpnGatewayIdString是vgw-3tehy13n2l4c6c0v****待查看VPN网关的ID。您可调用DescribeVpnGateways查询VPN网关的ID信息。

返回数据

名称类型示例值描述
RequestIdString20220322145233010225243081016A****请求ID。
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:59预期资源强制回收时间。
TagsArray of struct-VPN网关已添加的全部标签信息。具体请参见下表“Tag”。
ProjectNameStringProject_1VPN网关所属的项目。

IpsecEnabled

Boolean

true

是否开启IPSec功能。

  • true：开启
  • false：关闭

SslEnabled

Boolean

false

是否开启SSL VPN功能。

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

IsBlocked

Boolean

false

当前资源的状态是否被封禁。

  • true：封禁
  • false：未封禁
AsnInteger65534VPN网关的ASN。

Tag

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

请求示例

GET /?Action=DescribeVpnGatewayAttributes&Version=2020-04-01&VpnGatewayId=vgw-12bfa2du7fojk17q7y1rk**** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata":{
        "RequestId":"20220322145233010225243081016A****",
        "Action":"DescribeVpnGatewayAttributes",
        "Version":"2020-04-01",
        "Service":"vpn",
        "Region":"cn-beijing"
    },
    "Result":{
        "RequestId":"20220322145233010225243081016A****",
        "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",
        "OverdueTime":"",
        "ProjectName":"Project_1", 
        "IpsecEnabled": true,
        "SslEnabled": false,
        "SslMaxConnections": 10,
        "IsBlocked": false,
        "Asn": 65534,
        "Tags":[ 
						{	
						  "Key":"k1",	
						  "Value":"v1"	
						},	
						{	
						  "Key":"k2",	
						  "Value":""	
						}	
				]
    }
}

错误码

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

HttpCode错误码错误信息描述
404InvalidVpnGateway.NotFoundThe specified VPN gateway does not exist.指定的VPN网关不存在。