文档首页/ 虚拟专用网络 VPN/ API参考/ API/ 终端入云VPN API/ 终端入云VPN网关/ 查询P2C VPN网关连接信息列表
更新时间：2024-11-29 GMT+08:00
查看PDF
分享

查询P2C VPN网关连接信息列表

功能介绍

根据P2C VPN网关ID，查询连接列表。

调用方法

请参见如何调用API。

URI

GET /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/connections

表1 参数说明

名称

类型

是否必选

描述

project_id

String

是

项目ID，可以通过获取项目ID获取项目ID。

p2c_vgw_id

String

是

P2C VPN网关实例ID。
表2 请求Query参数列表

名称

类型

是否必选

描述

limit

Integer

否

分页查询时每页返回的记录数量。

offset

Integer

否

分页查询的偏移量。

请求消息

  • 请求参数

    无。

  • 请求样例

    1.不分页查询连接列表。

    GET https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/connections
    2.分页查询连接列表。 
    GET https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/connections?limit=10&offset=0

响应消息

  • 响应参数

    返回状态码为 200: 查询成功。

    表3 响应Body参数列表

    名称

    类型

    描述

    connections

    Array of Connection objects

    连接信息。

    total_count

    Long

    连接总数。

    request_id

    String

    请求ID。
    表4 Connection

    名称

    类型

    描述

    connection_id

    String
    • 功能说明：连接ID。
    • 格式：36位UUID。

    client_virtual_ip

    String

    客户端连接时分配的虚拟IP地址。

    client_ip

    String

    客户端连接的公网IP地址。

    client_user_name

    String

    客户端用户名称。

    inbound_packets

    Long

    入网包数。

    outbound_packets

    Long

    出网包数。

    inbound_bytes

    Long

    入网字节数。

    outbound_bytes

    Long

    出网字节数。

    connection_established_time

    String
    • 功能说明：客户端连接的建立时间。
    • UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。

    timestamp

    String
    • 功能说明：连接流量信息统计的时间戳。
    • UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。
  • 响应示例 
    {
    "connections": [
        {
            "connection_id": "10293371-114e-4d2a-878e-c6a616d0ec0e",
            "client_virtual_ip": "36.***.***.149",
            "client_ip": "100.***.***.100",
            "client_user_name": "1111",
            "inbound_packets": 13,
            "outbound_packets": 24,
            "inbound_bytes": 4185,
            "outbound_bytes": 10480,
            "connection_established_time": "2024-06-17T02:58:27.213Z",
            "timestamp": "2024-06-17T02:58:48Z"
        },
        {
            "connection_id": "6ade9de6-b19e-4b87-874d-f4880be317c1",
            "client_virtual_ip": "36.***.***.145",
            "client_ip": "100.***.***.100",
            "client_user_name": "1111",
            "inbound_packets": 13,
            "outbound_packets": 38,
            "inbound_bytes": 4185,
            "outbound_bytes": 15804,
            "connection_established_time": "2024-06-17T02:58:12.413Z",
            "timestamp": "2024-06-17T02:58:48Z"
        }
    ],
    "total_count": 2,
    "request_id": "6844f73ab1dd713d369b88904a935bd6"
}

状态码

请参见状态码。

父主题： 终端入云VPN网关

相关文档