Domain name for API request: vpc.tencentcloudapi.com.
This API (DescribeVpnConnections) is used to query the VPN tunnel list.
A maximum of 100 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: DescribeVpnConnections. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| VpnConnectionIds.N | No | Array of String | The instance ID of the VPN tunnel, such as vpnx-f49l6u0z. Each request can have a maximum of 100 instances. VpnConnectionIds and Filters cannot be specified at the same time. |
| Filters.N | No | Array of Filter | Filter condition. In each request, the upper limit for Filters is 10 and 5 for Filter.Values. VpnConnectionIds and Filters cannot be specified at the same time.vpc-0a36uwkr.vpngw-p4lmqawn.cgw-l4rblw63.test-vpn.vpnx-5p7vkch8". |
| Offset | No | Integer | The Offset. The default value is 0. For more information about Offset, see the relevant section in the API Introduction. |
| Limit | No | Integer | Number of values to be returned. The default value is 20. Maximum is 100. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | The number of instances meeting the filter condition. |
| VpnConnectionSet | Array of VpnConnection | VPN tunnel instance. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://vpc.tencentcloudapi.com/?Action=DescribeVpnConnections
&Version=2017-03-12
&<Common request parameters>{
"Response": {
"RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b",
"TotalCount": 1,
"VpnConnectionSet": [
{
"VpcId": "vpc-0a36uwkr",
"VpnConnectionId": "vpnx-5p7vkch8",
"VpnConnectionName": "testjoan",
"VpnGatewayId": "vpngw-p4lmqawn",
"CustomerGatewayId": "cgw-l4rblw63",
"PreShareKey": "123456",
"VpnProto": "IPSEC",
"EncryptProto": "IKE",
"RouteType": "STATIC",
"IKEOptionsSpecification": {
"PropoAuthenAlgorithm": "MD5",
"PropoEncryAlgorithm": "3DES-CBC",
"ExchangeMode": "MAIN",
"LocalIdentity": "ADDRESS",
"RemoteIdentity": "ADDRESS",
"LocalAddress": "183.60.249.17",
"RemoteAddress": "183.60.249.126",
"LocalFqdnName": "",
"RemoteFqdnName": "",
"DhGroupName": "GROUP1",
"IKESaLifetimeSeconds": "86400",
"IKEVersion": "IKEV1"
},
"IPSECOptionsSpecification": {
"EncryptAlgorithm": "3DES-CBC",
"IntegrityAlgorith": "MD5",
"EncapMode": "TUNNEL",
"SecurityProto": "ESP",
"PfsDhGroup": "NULL",
"IPSECSaLifetimeSeconds": "3600",
"IPSECSaLifetimeTraffic": "1843200"
},
"CreatedTime": "2017-08-0510: 27: 32",
"State": "AVAILABLE",
"NetStatus": "UNAVAILABLE",
"SecurityPolicyDatabaseSet": [
{
"LocalCidrBlock": "172.16.0.0/16",
"RemoteCidrBlock": [
"10.10.0.0/16"
]
}
]
}
]
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameter.Coexist | The parameters cannot be specified at the same time. |
| InvalidParameterValue.Malformed | Invalid input parameter format. |
| ResourceNotFound | The resource does not exist. |
Was this page helpful?