VPN Connet
VPN Connet
Document
- Documentation
VPN ConnetAPI referenceCustomer gatewayDescribeCustomerGateways - Querying customer gateways
Copy page
Download PDFCustomer gateway
DescribeCustomerGateways - Querying customer gateways
Copy pageDownload PDFDescribeCustomerGateways - Querying customer gateways
Call DescribeCustomerGateways to query customer gateways based on the specified conditions.
Debug
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.
Action String required Example: DescribeCustomerGateways
The action that you want to perform. Value: DescribeCustomerGateways.
Version String required Example: 2020-04-01
The API version.
PageSize Integer optional Example: 20
The number of entries per page in a pagination query. Maximum: 100. Default: 20.
PageNumber Integer optional Example: 1
Page number for pagination query.
- If you specify this parameter, it must be a non-negative integer.
- If you omit it or set it to 0, the value defaults to 1.
CustomerGatewayIds.N String optional Example: cgw-3tehy13n2l4c6c0v****
ID of the customer gateway.
- N represents the sequence number of a VPN gateway ID.
- Separate multiple IDs with ampersands (&).
CustomerGatewayName String optional Example: CGW-te001
The name of the customer gateway.
IpAddress String optional Example: 8.XX.XX.8
The egress IP address of the customer gateway.
ProjectName String optional Example: Project_1
The project to which the customer gateway belongs.
- If you provide this field, the system will query customer gateways under the specified project.
- If you omit this field, the system will query customer gateways across all projects.
Status String optional Example: Available
The status of the customer gateway.
- Creating
- Deleting
- Pending: Configuration in progress.
- Available
TagFilters.N.Key String optional Example: key1
The specified tag key when querying resources by tag.
- N represents the sequence number of a tag key. Values: 1-10.
- Separate multiple tag keys with &.
- Duplicate values are not allowed.
TagFilters.N.Values.M String optional Example: value1
The specified tag value when querying resources by tag.
- The first N represents the sequence number of a tag key. Valid values: 1–10.
- The second N represents the sequence number of a tag value. Value range: 1–3. That is, you can query up to three tag values for the same tag key.
- Separate multiple tag values with ampersands (&).
- To provide this parameter, you must provide TagFilters.N.Key.
- If you only provide TagFilters.N.Key without this parameter, the system will query all tag values of the same tag key.
- If you provide an empty string, the system will query tags with an empty tag value.
- If you set multiple TagFilters.N.Values.M values for the same TagFilters.N.Key, these TagFilters.N.Values.M values are combined with a logical OR.
IpVersion String optional Example: ipv4
The IP protocol type of the VPN gateway. Values:
- ipv4 (default)
- ipv6
Response parameters
Only the response parameters specific to this API are listed below. For more information, see Response structure.
RequestId String Example: 202203211611080102121461940900****
Request ID.
PageSize Integer Example: 20
The number of rows on the current page.
PageNumber Integer Example: 1
Current page number.
TotalCount Integer Example: 33
Total number of customer gateways that meet the conditions.
CustomerGateways Object[] Example: -
Details of the customer gateway.
AccountId String Example: 20005****
The account ID associated with the customer gateway.
CustomerGatewayId String Example: cgw-3tehy13n2l4c6c0v****
ID of the customer gateway.
IpAddress String Example: 8.XX.XX.8
The egress IP address of the customer gateway.
ConnectionCount Integer Example: 8
The number of IPsec-VPN connections associated with the customer gateway.
CreationTime String Example: 2021-04-09T08:36:47+08:00
The time when the customer gateway is created.
UpdateTime String Example: 2021-04-09T10:30:00+08:00
The time when the customer gateway is created.
CustomerGatewayName String Example: CGW-q04n
The name of the customer gateway.
Description String Example: This is a sample description
Description of the customer gateway.
Status String Example: Available
The status of the customer gateway.
- Creating
- Deleting
- Pending: Configuration in progress.
- Available
ProjectName String Example: Project_1
The project to which the customer gateway belongs.
Asn Integer Example: 65001
The ASN of the customer gateway.
Tags Object[] Example: -
Information about all tags associated with the customer gateway.
Key String Example: key1
The tag key.
Value String Example: value1
The tag value.
IpVersion String Example: ipv4
The IP address protocol type of the VPN gateway.
- ipv4
- ipv6
Request examples
GET /?Action=DescribeCustomerGateways&Version=2020-04-01&CustomerGatewayIds.1=cgw-7qthudw0ll6jmc****&PageNumber=1&PageSize=20 HTTP/1.1
Host: vpn.cn-beijing.volcengineapi.com
X-Date: 20251029T033538Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251029/cn-beijing/vpn/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
Response examples
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "DescribeCustomerGateways",
"Version": "2020-04-01",
"Service": "vpn",
"Region": "cn-beijing"
},
"Result": {
"CustomerGateways": [
{
"Asn": 65001,
"Tags": [
{
"Key": "key1",
"Value": "value1"
}
],
"Status": "Available",
"AccountId": "20005****",
"IpAddress": "8.XX.XX.8",
"IpVersion": "ipv4",
"UpdateTime": "2021-04-09T10:30:00+08:00",
"Description": "This is a sample description",
"ProjectName": "Project_1",
"CreationTime": "2021-04-09T08:36:47+08:00",
"ConnectionCount": 8,
"CustomerGatewayId": "cgw-3tehy13n2l4c6c0v****",
"CustomerGatewayName": "CGW-q04n"
}
],
"PageNumber": 1,
"PageSize": 20,
"RequestId": "202203211611080102121461940900****",
"TotalCount": 33
}
}
Error codes
The following table lists the error codes related to the business logic for this API. For details, see Common error codes.
Last updated: 2026.05.09 11:19:49
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
