DescribeCustomerGateways

Last Updated At: 2026-08-02 00:06:22

1. Interface Description

Interface request domain name: vpc.api3.convergecloud.com.

This API (DescribeCustomerGateways) is used to query the list of customer gateways.

Default interface request rate limit: 100 times per second.

Interface update time: 2019-03-29 19:27:35.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name	Required	Allow NULL	Type	Description
Action	Yes	No	String	Public parameter, The value of this interface: DescribeCustomerGateways
Version	Yes	No	String	Public parameter, The value of this interface: 2017-03-12
Region	No	No	String	Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
CustomerGatewayIds	No	No	Array of String	Customer gateway ID, e.g., cgw-2wqq41m9. The upper limit of instances per request is 100. Parameters CustomerGatewayIds and Filters must not be specified simultaneously. Example: cgw-2wqq41m9
Filters	No	No	Array of Filter	Filtering conditions are detailed in the table below: Instance Filtering Conditions Table. Each request can include up to 10 Filters, with a maximum of 5 values for each Filter.Values. The parameters CustomerGatewayIds and Filters cannot be specified simultaneously. customer-gateway-id - String - (filtering condition) unique ID of the user gateway, such as `cgw-mgp33pll`. customer-gateway-name - String - (filtering condition) name of the user gateway, such as `demo-cgw`. ip-address - String - (filtering condition) public network address, such as `58.211.1.12`. Example:View
Offset	No	No	Uint64	Offset. The default value is 0. For further introduction about Offset, refer to the relevant sections in the API Overview. Example: 0
Limit	No	No	Uint64	Number of returns, 20 by default, up to 100. Example: 10

3. Output Parameters

Parameter name	Type	Description
CustomerGatewaySet	Array of CustomerGateway	Customer gateway object list Example:View
TotalCount	Uint64	Number of eligible instances. Example:
RequestId	String	Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code	Description
InvalidParameterValue.Malformed	Invalid input format.
ResourceNotFound	The resource does not exist