You need to enable JavaScript to run this app.
导航

DescribeVpnConnections

最近更新时间2024.01.09 07:37:33

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

调用DescribeVpnConnections查询满足指定条件的IPsec连接。

请求参数

名称类型是否必选示例值
描述
ActionStringDescribeVpnConnections要执行的操作,取值:DescribeVpnConnections
VersionString2020-04-01API版本信息。
PageSizeInteger20分页查询时每页的行数。取值范围:1~100,默认值为20。

PageNumber

Integer

1

列表的页。

  • 如需传入此参数,请传入非负整数。
  • 不传或传入0,则均默认为1。

VpnConnectionIds.N

List of String

VpnConnectionIds.1=vgc-273zkshb2qayo7fap8t21****&VpnConnectionIds.2=vgc-qdifks098jodu3****

IPsec连接的ID。

  • 参数 - N:表示IPsec连接ID的序号。
  • 多个ID之间用&分隔。
VpnConnectionNameStringtest-001IPsec连接的名称。
VpnGatewayIdStringvgw-3tex2x1cwd4c6c0v****IPsec连接关联的VPN网关的ID。您可调用DescribeVpnGateways查询VPN网关的ID信息。
CustomerGatewayIdStringcgw-3tehy13n2l4c6c0v****IPsec连接关联的用户网关的ID。您可调用DescribeCustomerGateways查询用户网关的ID信息。

ProjectName

String

Project_1

IPsec连接所属的项目的名称。

  • 传入该字段,表示查询指定项目下的IPsec连接。
  • 不传入该字段,表示查询所有项目的IPsec连接。

AttachType

String

VpnGateway

IPsec连接关联网关的类型。

  • VpnGateway:VPN网关
  • TransitRouter:中转路由器

AttachStatus

String

Attached

IPsec连接状态。

  • IPsec连接关联VpnGateway:
    • Attached:已绑定
  • IPsec连接关联TransitRouter:
    • Attached:已绑定
    • Attaching:绑定中
    • Detached:已解绑
    • Detaching:解绑中

TransitRouterId

String

tr-bp1osj4c1q84p7syi****

中转路由器的ID。您可调用DescribeTransitRouters查询中转路由器的ID信息。

说明

AttachType传入值为TransitRouter,则可传入此参数进行精确搜索。若AttachType传入值为VpnGateway,无需传入此参数。

返回数据

名称类型
示例值
描述
RequestIdString20220322145233010225243081016A****请求ID。
PageSizeInteger20当前分页的行数。
PageNumberInteger1当前页码。
TotalCountInteger33符合查询条件的IPsec连接的数量。
VpnConnectionsArray of struct-IPsec连接的详细信息,具体请见下表“VpnConnection”。

VpnConnection

名称类型
示例值
描述
RequestIdString0ED8D006-F706-4D23-88ED-E11ED28D****请求ID。
AccountIdString2000****IPsec连接所属账户的ID。
VpnConnectionIdStringvgc-3tehy13n2l4c6c0v****IPsec连接的ID。
CreationTimeString2021-04-09T08:36:47+08:00创建IPsec连接的时间。
UpdateTimeString2021-04-010T08:36:47+08:00更新IPsec连接的时间。
VpnConnectionNameStringabcIPsec连接的名称。
DescriptionStringThis is a sample descriptionIPsec连接的描述信息。

Status

String

Available

IPsec连接的状态。

  • Creating: 创建中
  • Deleting: 删除中
  • Pending:配置中
  • Available:可用
VpnGatewayIdStringvgw-3tex2x1cwd4c6c0v****IPsec连接关联的VPN网关的ID。
CustomerGatewayIdStringcgw-3tehy13n2l4c6c0v****IPsec连接关联的用户网关的ID。
LocalSubnetList["10.0.XX.XX/24","10.0.XX.XX/24"]IPsec连接的本端网段。
RemoteSubnetList["192.168.XX.XX/24","192.168.XX.XX/24"]IPsec连接的对端网段。

DpdAction

String

clear

是否开启了DPD功能。

  • none:未开启DPD功能。
  • clear:已开启DPD功能,DPD超时后清除IKE SA。
  • hold:已开启DPD功能,DPD超时后保持当前状态,等待新的流量进入后重新建立连接。
  • restart:已开启DPD功能,DPD超时后立即重连。

ConnectStatus

String

ike_sa_negotiation_completed

IPsec连接的状态。

  • ike_sa_negotiation_failed:第一阶段协商未成功
  • ike_sa_negotiation_completed:第一阶段协商成功
  • ipsec_sa_negotiation_failed:第二阶段协商未成功
  • ipsec_sa_negotiation_completed:第二阶段协商成功
IkeConfigStruct-IPsec连接的IKE配置的信息。具体请参见下表“IkeConfig”。
IpsecConfigStruct-IPsec连接的IPsec配置的信息。具体请参见下表“IpsecConfig”。

NatTraversal

Boolean

false

是否开启了NAT穿越功能。

  • true:已开启。
  • false:未开启。
ProjectNameStringProject_1IPsec连接所属的项目。

NegotiateInstantly

Boolean

true

是否立即发起协商模式。

  • true:IPsec连接配置完成后系统立即主动发起协商。
  • false:IPsec连接配置完成后系统不主动发起协商,当有流量通过时被动发起协商。

AttachStatus

String

Attached

IPsec连接状态。

  • VpnGateway:
    • Attached:已绑定
  • TransitRouter:
    • Attached:已绑定
    • Attaching:绑定中
    • Detached:已解绑
    • Detaching:解绑中

AttachType

String

VpnGateway

IPsec连接关联网关的类型。

  • VpnGateway:VPN网关
  • TransitRouter:中转路由器
IpAddressString180.XX.XX.182中转路由器的公网IP地址,仅AttachType为“TransitRouter”时返回此参数。
TransitRouterIdStringtr-bp1osj4c1q84p7syi****中转路由器的ID,仅AttachType为“TransitRouter”时返回此参数。
ZoneIdStringcn-beijing-a中转路由器连接点的可用区,仅AttachType为“TransitRouter”时返回此参数。

BusinessStatus

String

Normal

IPsec连接的计费状态,仅AttachType为“TransitRouter”时返回此参数。

  • Normal: 正常。
  • FinancialLocked: 被锁定。
DeletedTimeString2022-12-07 23:23:23预期资源强制回收时间。仅AttachType为“TransitRouter”时返回此参数,且当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
OverdueTimeString2022-12-07 23:23:23资源冻结时间。仅AttachType为“TransitRouter”时返回此参数,且当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。

LogEnabled

Boolean

false

是否启用了连接日志。

  • true:启用。
  • false:未启用。

IkeConfig

名称类型
示例值
描述
VersionStringikev1IKE密钥交换协议的版本
PskString12345***预共享密钥,用于第一阶段VPN网关与用户网关之间的身份认证。
DhGroupStringgroup2第一阶段协商使用的DH(Diffie-Hellman)密钥交换算法。
ModeStringmain第一阶段的协商模式。若IKE密钥交换协议的版本为ikev2时,此处返回空字符串。
EncAlgStringaes第一阶段协商的加密算法。
AuthAlgStringsha1第一阶段协商的认证算法。
LocalIdString2.XX.XX.2VPN网关的标识,用于第一阶段的协商。
RemoteIdString1.XX.XX.1用户网关的标识,用于第一阶段的协商。
LifetimeInteger86400第一阶段协商的SA的生存时间,超过生存时间后,将重新发起协商。

IpsecConfig

名称类型
示例值
描述
AuthAlgStringsha1第二阶段协商的认证算法。
EncAlgStringaes第二阶段协商的加密算法。
DhGroupStringgroup2第二阶段使用的DH(Diffie-Hellman)密钥交换算法。
LifetimeInteger86400第二阶段协商的SA的生存时间,超过生存时间后,将重新发起协商。

请求示例

GET /?Action=DescribeVpnConnections&Version=2020-04-01&VpnConnectionIds.1=vgc-2bzvqi8kerd342dx0eg2f****&PageNumber=1&PageSize=20 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220322145233010225243081016A****",
        "Action": "DescribeVpnConnections",
        "Version": "2020-04-01",
        "Service": "vpn",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20220322145233010225243081016A****",
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "VpnConnections": [
            {
                "RequestId": "638cf5d5-04a7-4940-bb74-d51f9985****",
                "AccountId": "210000****",
                "VpnConnectionId": "vgc-2bzvqi8kerd342dx0eg2f****",
                "VpnConnectionName": "test",
                "CreationTime": "2022-03-13T17:50:42+08:00",
                "UpdateTime": "2022-03-18T06:31:21+08:00",
                "Description": "test",
                "Status": "Available",
                "VpnGatewayId": "vgw-2d670iixygs8w58ozfde1****",
                "CustomerGatewayId": "cgw-2d670j4napdz458ozfd8y****",
                "ProjectName":"Project_1",
                "LocalSubnet": [
                    "192.XX.XX.0/16"
                ],
                "RemoteSubnet": [
                    "172.XX.XX.0/16"
                ],
                "NatTraversal": false,
                "DpdAction": "clear",
                "ConnectStatus": "ike_sa_negotiation_completed",
                "NegotiateInstantly": true,
                "AttachStatus": "Attached",
                "AttachType": "VpnGateway",
                "LogEnabled": false,
                "IkeConfig": {
                    "Version": "ikev2",
                    "Psk": "12345",
                    "DhGroup": "group2",
                    "Mode": "main",
                    "EncAlg": "aes",
                    "AuthAlg": "sha1",
                    "Lifetime": 86400,
                    "LocalId": "2.XX.XX.2",
                    "RemoteId": "1.XX.XX.1"
                },
                "IpsecConfig": {
                    "EncAlg": "aes",
                    "AuthAlg": "sha1",
                    "Lifetime": 86400,
                    "DhGroup": "group2"
                }
            }
        ]
    }
}

错误码

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

HttpCode错误码错误信息描述
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400LimitExceeded.VpnConnectionIdYou've reached the limit on the number of IPSec connection IDs that you can describe.已达到可查询的IPSec连接ID数量上限。