文档首页/ 虚拟专用网络 VPN/ API参考/ API/ 站点入云VPN API/ VPN连接/ 导出VPN连接配置 - ExportPeerConfig
更新时间:2026-04-24 GMT+08:00
分享

导出VPN连接配置 - ExportPeerConfig

功能介绍

根据选定的对端设备,导出VPN连接在对端设备的配置。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

vpn:vpnConnections:exportPeerConfig

write

vpnConnections

-

-

URI

POST /v5/{project_id}/vpn-connection/{vpn_connection_id}/peer-configuration/export

表1 参数说明

名称

类型

是否必选

说明

project_id

String

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

vpn_connection_id

String

VPN连接ID。

请求消息

  • 请求参数
    表2 请求参数

    名称

    类型

    是否必选

    描述

    vendor

    String

    厂商。

    type

    String

    系列。

    model

    String

    型号。

    version

    String

    版本。

  • 请求样例
    POST https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id}/peer-configuration/export
    
    {
      "vendor": "vendor-name-1",
      "type": "type-1"
      "model": "model-1",
      "version": "1.0"
    }

响应消息

  • 响应参数

    返回状态码为 200: successful operation。

    表3 响应Body参数列表

    名称

    类型

    描述

    request_id

    String

    请求ID。

    peer_config

    String

    对端配置信息。

  • 响应样例
    {
        "request_id": "e905df2f8ec9f68f1d8c53a692dc7eea",
        "peer_config": "the configuration information of the peer device"
    }

状态码

请参见状态码

相关文档