Last updated: 2019-11-29 18:11:06

1. API Description

Domain name for API request:

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

A maximum of 100 requests can be initiated per second for this API.

Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example:

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 parameter. The value used for this API: DescribeCustomerGateways
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.
CustomerGatewayIds.N No Array of String Customer gateway ID, such as cgw-2wqq41m9. A maximum of 100 instances are allowed for each request. CustomerGatewayIds and Filters cannot be specified at the same time.
Filters.N No Array of Filter Filter condition. For more information, see the Table of Instance Filter Conditions below. The maximum number of Filters for each request is 10, and the maximum number of Filter.Values is 5. CustomerGatewayIds and Filters cannot be specified at the same time.
Offset No Integer Offset. Default is 0. For more information about Offset, see the relevant section in API Introduction.
Limit No Integer Number of values to be returned. Default is 20. Maximum is 100.

3. Output Parameters

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

4. Error Codes

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 Resource does not exist.

5. Example

Example 1 Query customer gateways

Input example
&<Common request parameters>

Output example

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

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.