ModifyVpnConnectionAttribute

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ModifyVpnConnectionAttribute.
Version	Yes	String	Common Params. The value used for this API: 2017-03-12.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
VpnConnectionId	Yes	String	The ID of the VPN tunnel instance, such as `vpnx-f49l6u0z`.
VpnConnectionName	No	String	VPN tunnel can be named freely, but the maximum length is 60 characters.
PreShareKey	No	String	The pre-shared key.
SecurityPolicyDatabases.N	No	Array of SecurityPolicyDatabase	SPD policy group. Taking {"10.0.0.5/24":["172.123.10.5/16"]} as an example, 10.0.0.5/24 is the VPC private IP range, and 172.123.10.5/16 is the IDC IP range. The user specifies the IP range in the VPC that can communicate with the IP range in the IDC.
IKEOptionsSpecification	No	IKEOptionsSpecification	IKE (Internet Key Exchange) configuration. IKE comes with a self-protection mechanism. The network security protocol is configured by the user.
IPSECOptionsSpecification	No	IPSECOptionsSpecification	IPSec configuration. The IPSec secure session configuration is provided by Tencent Cloud.
EnableHealthCheck	No	Boolean	Whether to enable the tunnel health check. The default value is `False`.
HealthCheckLocalIp	No	String	Local IP address for the tunnel health check
HealthCheckRemoteIp	No	String	Peer IP address for the tunnel health check
NegotiationType	No	String	Negotiation type. Valid values: `active` (default value), `passive` and `flowTrigger`.
DpdEnable	No	Integer	Specifies whether to enable DPD. Valid values: `0` (disable) and `1` (enable)
DpdTimeout	No	String	DPD timeout period. Default: 30; unit: second. If the request is not responded within this period, the peer end is considered not exists. This parameter is valid when the value of `DpdEnable` is 1.
DpdAction	No	String	The action after DPD timeout. Valid values: `clear` (disconnect) and `restart` (try again). It’s valid when `DpdEnable` is `1`.
CustomerGatewayId	No	String	Peer gateway ID. You can update tunnels of V4.0 and later gateways.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modifying a VPN tunnel

This example shows you how to modify a VPN tunnel.

Input Example

POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyVpnConnectionAttribute
<Common request parameters>

{
    "VpnConnectionName": "test-abc",
    "VpnConnectionId": "vpnx-abc123x",
    "PreShareKey": "123",
    "EnableHealthCheck": "false"
}

Output Example

{
    "Response": {
        "RequestId": "b6c8a8c4-ba39-49ca-9b21-66247b7e3ad3"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InvalidParameterValue.LimitExceeded	The parameter value exceeds the limit.
InvalidParameterValue.Malformed	Invalid input parameter format.
InvalidParameterValue.VpnConnCidrConflict	Destination IP address range conflicts with CIDR block of the current VPC tunnel.
InvalidParameterValue.VpnConnHealthCheckIpConflict	The destination IP of the probe cannot be within the IP range of the VPC.
ResourceNotFound	The resource does not exist.
UnsupportedOperation.InvalidState	Invalid resource status.
UnsupportedOperation.VpnConnInvalidState	Operation failed: The tunnel is not available now.
UnsupportedOperation.VpnConnSPDOverlap

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Modifying a VPN tunnel

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

About Tencent Cloud

Help & Support

Resources

User Center

tencent cloud

Sign Up

Log in

Compute

Microservice

Data Migration

Database SaaS Tool

Data Security

Application Security

Big Data

Voice Technology

Internet of Things

Stream Services

Cloud Real-time Rendering

Cloud Resource Management

More

Edge Computing

Serverless

Relational Database

Networking

Business Security

Domains & Websites

Face Recognition

AI Platform Service

Middleware

Media On-Demand

Game Services

Management and Audit Tools

Container

Essential Storage Service

Enterprise Distributed DBMS

CDN and Acceleration

Security Services

Enterprise Applications

Tencent Big Model

Natural Language Processing

Communication

Media Process Services

Education Sevices

Developer Tools

Distributed cloud

Data Process and Analysis

NoSQL Database

Network Security

Cloud Security

Office Collaboration

Image Creation

Optical Character Recognition

Interactive Video Services

Media SDK

Medical Services

Monitor and Operation

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Modifying a VPN tunnel

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

About Tencent Cloud

Help & Support

Resources

User Center