tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

GenerateVpnConnectionDefaultHealthCheckIp

最后更新时间：2023-08-23 14:11:08

1. API Description

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

This API is used to get a pair of VPN tunnel health check addresses.

A maximum of 20 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: GenerateVpnConnectionDefaultHealthCheckIp.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
VpnGatewayId Yes String VPN gateway ID, such as vpngw-1w9tue3d

3. Output Parameters

Parameter Name Type Description
HealthCheckLocalIp String Local IP used for VPN tunnel health check
HealthCheckRemoteIp String Remote IP used for VPN tunnel health check
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining a pair of VPN tunnel health check addresses

This example shows you how to get a pair of VPN tunnel health check addresses.

Input Example

https://vpc.tencentcloudapi.com/?Action=GenerateVpnConnectionDefaultHealthCheckIp
&VpnGatewayId=vpn-ngenl4az
&<Common request parameters>

Output Example

{
    "Response": {
        "HealthCheckLocalIp": "169.254.128.2",
        "HealthCheckRemoteIp": "169.254.128.5",
        "RequestId": "6e446c86-d8c9-4981-9b33-d10956585058"
    }
}

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.
ResourceNotFound The resource does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款