更新时间:2024-01-26 GMT+08:00
分享

创建VPN连接监控

功能介绍

创建VPN连接监控。连接监控是网关之间的健康检查,添加健康检查可以配置VPN网关、向对端网关发送监测报文,统计链路往返时延和丢包率,用于检测VPN连接的质量。

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/connection-monitors

表1 参数说明

名称

类型

是否必选

说明

project_id

String

项目ID,可以通过获取项目ID获取项目ID

请求消息

  • 请求参数
    表2 请求参数

    名称

    类型

    是否必选

    描述

    connection_monitor

    CreateConnectionMonitorRequestBodyContent object

    connection_monitor对象

    表3 CreateConnectionMonitorRequestBodyContent

    名称

    类型

    是否必选

    描述

    vpn_connection_id

    String

    VPN连接监控对应的VPN连接ID。

    可以通过查询VPN连接列表查看VPN连接ID。

  • 请求样例
    POST https://{Endpoint}/v5/{project_id}/connection-monitors
    
    {
        "connection_monitor": {
            "vpn_connection_id": "cae286f2-****-****-****-e22416ca1220"
        }
    }

响应消息

  • 响应参数

    返回状态码为 201: successful operation

    表4 响应Body参数列表

    名称

    类型

    描述

    connection_monitor

    ConnectionMonitorInfo object

    connection_monitor对象

    request_id

    String

    请求ID

    表5 ConnectionMonitorInfo

    名称

    类型

    描述

    id

    String

    • 功能说明:VPN连接监控ID
    • 格式:36位UUID

    vpn_connection_id

    String

    • 功能说明:VPN连接监控对应的VPN连接ID
    • 格式:36位UUID

    type

    String

    • 功能说明:监控类型
    • 取值范围:gateway

    source_ip

    String

    VPN连接监控的源地址

    destination_ip

    String

    VPN连接监控的目的地址

    proto_type

    String

    • 功能说明:nqa使用的协议类型
    • 取值范围:icmp
  • 响应样例
    {
        "connection_monitor":{
            "id":"76f64229-****-****-****-3907e2815b6d",
            "vpn_connection_id":"cae286f2-****-****-****-e22416ca1220",
            "type":"gateway",
            "source_ip":"88.***.***.60",
            "destination_ip":"88.***.***.32",
            "proto_type":"icmp"
        },
        "request_id": "bd37d16d-387c-41ab-a180-01b649f73590"
    }

状态码

请参见状态码

分享:

    相关文档

    相关产品