tencent cloud

文档反馈

ModifyVpnConnectionAttribute

最后更新时间:2022-08-24 17:35:45

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API (ModifyVpnConnectionAttribute) is used to modify VPN tunnels.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
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 The SPD policy group, for example: {"10.0.0.5/24":["172.123.10.5/16"]}. 10.0.0.5/24 is the VPC internal 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.
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.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. 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

https://vpc.tencentcloudapi.com/?Action=ModifyVpnConnectionAttribute
&VpnConnectionId=vpnx-i0f4fo4m
&VpnConnectionName=new_name
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
    }
}

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

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.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.
联系我们

联系我们,为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持