文档首页/ 虚拟专用网络 VPN/ API参考/ API/ 终端入云VPN API/ 服务端/ 导出VPN服务端对应的客户端配置
更新时间：2024-11-29 GMT+08:00
查看PDF
分享

导出VPN服务端对应的客户端配置

功能介绍

根据VPN服务端ID，导出客户端配置信息。

调用方法

请参见如何调用API。

URI

POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/client-config/export
表1 参数说明

名称

类型

是否必选

描述

project_id

String

是

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

vpn_server_id

String

是

VPN服务端ID。

请求消息

  • 请求参数
    表2 请求参数

    名称

    类型

    是否必选

    描述

    os_type

    String

    否
    • 功能说明：操作系统类型。
    • 取值范围

      Windows

      Linux

      MacOS

      Android

      iOS

    • 默认值：Windows。
  • 请求样例 
    POST https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/client-config/export

{
  "os_type": "Windows"
}

响应消息

  • 响应参数

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

    表3 响应Body参数列表

    名称

    类型

    描述

    client_config

    string

    客户端配置。
  • 响应示例 
    {
    "client_config": "client\ndev tun\nproto tcp\nremote 215.xx.xx.99 443\nresolv-retry infinite\nnobind\npersist-key\npersist-tun\nremote-cert-tls server\ndata-ciphers AES-128-GCM\nauth SHA256\nverb 3\nauth-user-pass\n<ca>\n-----BEGIN CERTIFICATE-----*****-----END CERTIFICATE-----\n</ca>\n\n\nreneg-sec 0\n# Add a comment character (#) in front of disable-dco when OpenVPN 2.5 or earlier is used.\ndisable-dco\n"
}

状态码

请参见状态码。

父主题： 服务端

相关文档