tencent cloud



Last updated: 2022-08-24 17:35:48

1. API Description

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

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

A maximum of 100 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: DescribeCustomerGateways.
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.
CustomerGatewayIds.N No Array of String Customer gateway ID, such as cgw-2wqq41m9. Each request can have a maximum of 100 instances. CustomerGatewayIds and Filters cannot be specified at the same time.
Filters.N No Array of Filter The filter condition. For details, see the Instance Filter Conditions Table. The upper limit for Filters in each request is 10 and 5 for Filter.Values. CustomerGatewayIds and Filters cannot be specified at the same time.
  • customer-gateway-id - String - (Filter condition) The unique ID of the user gateway, such as cgw-mgp33pll.
  • customer-gateway-name - String - (Filter condition) The name of the user gateway, such as test-cgw.
  • ip-address - String - (Filter condition) The public IP address, such as
  • 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 returned results. Default value: 20. Maximum value: 100.

    3. Output Parameters

    Parameter Name Type Description
    CustomerGatewaySet Array of CustomerGateway Customer gateway object list
    TotalCount Integer Number of eligible instances
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying customer gateways

    Input Example

    &<Common request parameters>

    Output Example

        "Response": {
            "CustomerGatewaySet": [
                    "CustomerGatewayId": "cgw-mgp33pll",
                    "IpAddress": "",
                    "CustomerGatewayName": "test-cgw",
                    "CreatedTime": "2018-03-25 17:52:39"
            "TotalCount": 1,
            "RequestId": "e5500b60-4964-43c7-8a6c-4bff98f59aeb"

    5. Developer Resources


    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.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support