Catatan Rilis
Announcements
Domain name for API request: vpc.intl.tencentcloudapi.com.
This API is used to used to query the list of VPN tunnels.
A maximum of 100 requests can be initiated per second for this API.
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: DescribeVpnConnections. |
| 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. |
| 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, 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. |
This example shows you how to query VPN tunnels.
POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVpnConnections
<Common request parameters>
{
"Limit": "5",
"Offset": "0"
}{
"Response": {
"TotalCount": 2,
"VpnConnectionSet": [
{
"VpcId": "vpc-8ro3x6md",
"VpnConnectionId": "vpnx-df9oztok",
"VpnConnectionName": "testcon-1",
"VpnGatewayId": "vpngw-6x0wxvtp",
"CustomerGatewayId": "cgw-apytvc1n",
"PreShareKey": "123",
"VpnProto": "IPSEC",
"EncryptProto": "IKE",
"RouteType": "StaticRoute",
"IKEOptionsSpecification": {
"PropoAuthenAlgorithm": "MD5",
"PropoEncryAlgorithm": "AES-CBC-128",
"ExchangeMode": "MAIN",
"LocalIdentity": "ADDRESS",
"RemoteIdentity": "ADDRESS",
"LocalAddress": "6.6.6.6",
"RemoteAddress": "1.1.3.2",
"LocalFqdnName": "",
"RemoteFqdnName": "",
"DhGroupName": "GROUP1",
"IKESaLifetimeSeconds": 86400,
"IKEVersion": "IKEV1"
},
"IPSECOptionsSpecification": {
"EncryptAlgorithm": "AES-CBC-128",
"IntegrityAlgorith": "MD5",
"PfsDhGroup": "NULL",
"IPSECSaLifetimeSeconds": 3600,
"IPSECSaLifetimeTraffic": 1843200
},
"CreatedTime": "2022-07-22 14:05:07",
"SecurityPolicyDatabaseSet": [
{
"LocalCidrBlock": "0.0.0.0/0",
"RemoteCidrBlock": [
"0.0.0.0/0"
]
}
],
"State": "AVAILABLE",
"NetStatus": "AVAILABLE",
"NegotiationType": "flowTrigger",
"DpdEnable": 1,
"DpdTimeout": "30",
"DpdAction": "clear",
"EnableHealthCheck": false,
"HealthCheckLocalIp": "",
"HealthCheckRemoteIp": "",
"HealthCheckStatus": "",
"TagSet": []
},
{
"VpcId": "vpc-8ro3x6md",
"VpnConnectionId": "vpnx-eal8tpn2",
"VpnConnectionName": "testcon-2",
"VpnGatewayId": "vpngw-6x0wxvtp",
"CustomerGatewayId": "cgw-876ql2tz",
"PreShareKey": "123",
"VpnProto": "IPSEC",
"EncryptProto": "IKE",
"RouteType": "StaticRoute",
"IKEOptionsSpecification": {
"PropoAuthenAlgorithm": "MD5",
"PropoEncryAlgorithm": "AES-CBC-128",
"ExchangeMode": "MAIN",
"LocalIdentity": "ADDRESS",
"RemoteIdentity": "ADDRESS",
"LocalAddress": "6.6.6.6",
"RemoteAddress": "169.168.10.4",
"LocalFqdnName": "",
"RemoteFqdnName": "",
"DhGroupName": "GROUP1",
"IKESaLifetimeSeconds": 86400,
"IKEVersion": "IKEV1"
},
"IPSECOptionsSpecification": {
"EncryptAlgorithm": "AES-CBC-128",
"IntegrityAlgorith": "MD5",
"PfsDhGroup": "NULL",
"IPSECSaLifetimeSeconds": 3600,
"IPSECSaLifetimeTraffic": 1843200
},
"CreatedTime": "2022-07-22 14:14:48",
"SecurityPolicyDatabaseSet": [
{
"LocalCidrBlock": "0.0.0.0/0",
"RemoteCidrBlock": [
"0.0.0.0/0"
]
}
],
"State": "AVAILABLE",
"NetStatus": "AVAILABLE",
"NegotiationType": "passive",
"DpdEnable": 1,
"DpdTimeout": "31",
"DpdAction": "clear",
"EnableHealthCheck": false,
"HealthCheckLocalIp": "",
"HealthCheckRemoteIp": "",
"HealthCheckStatus": "",
"TagSet": []
}
],
"RequestId": "1f4fa69d-0a9b-4342-83e1-002533feca94"
}
}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 |
|---|---|
| InternalError.ModuleError | Internal module error |
| InvalidParameter.Coexist | The parameters cannot be specified at the same time. |
| InvalidParameter.FilterInvalidKey | The specified filter condition does not exist. |
| InvalidParameterValue.LimitExceeded | The parameter value exceeds the limit. |
| InvalidParameterValue.Malformed | Invalid input parameter format. |
| ResourceNotFound | The resource does not exist. |
| UnsupportedOperation | Unsupported operation. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan