Exporting VPN Connection Configurations

Function

This API is used to export VPN connection configurations on a specified customer gateway device.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

• If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
• If you are using identity policy-based authorization, the following identity policy-based permissions are required.

URI

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

Request

• Request parameters

  Table 2 Request parameters

  Parameter	Type	Mandatory	Description
  vendor	String	Yes	Specifies a vendor.
  type	String	Yes	Specifies a device series.
  model	String	Yes	Specifies a device model.
  version	String	Yes	Specifies a device version.

• Example request

  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"
  }

Response

• Response parameters

  Returned status code 200: successful operation

  Table 3 Parameters in the response body

  Parameter	Type	Description
  request_id	String	Specifies a request ID.
  peer_config	String	Specifies peer configurations.

• Example response

  {
      "request_id": "e905df2f8ec9f68f1d8c53a692dc7eea",
      "peer_config": "the configuration information of the peer device"
  }

Status Codes

For details, see Status Codes.