Updated on 2026-06-11 GMT+08:00

Resetting a VPN Connection

Function

This API is used to reset a VPN connection with a specified connection ID.

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.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

vpn:vpnConnections:reset

write

vpnConnections

  • g:EnterpriseProjectId
  • g:ResourceTag/<tag-key>

-

-

URI

POST /v5/{project_id}/vpn-connection/{vpn_connection_id}/reset

Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

String

Yes

Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID.

vpn_connection_id

String

Yes

Specifies a VPN connection ID.

Request

  • Request parameters

    None

  • Example request
    POST https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id}/reset

Response

  • Response parameters

    Returned status code 200: successful operation

    Table 2 Parameters in the response body

    Parameter

    Type

    Description

    request_id

    String

    Specifies a request ID.

  • Example response
    {
      "request_id": "c63d850876bcddbdfbd11776cce57914"
    }

Status Codes

For details, see Status Codes.