edit-icon download-icon


Last Updated: Apr 12, 2018


Query the list of customer gateways.

Request parameters

Name Type Required Description
Action String Yes

The action to perform.

Valid value: DescribeCustomerGateways

RegionId String yes

The region of the customer gateway.

You can obtain the region ID by calling the DescribeRegions API.

CustomerGatewayId String No The ID of the customer gateway.
PageNumber Integer No The number of pages to return. The default value is 1.
PageSize Integer No The number of rows per page. The maximum value is 50 and the default value is 10.

Response parameters

Name Type Description
RequestId String The ID of the request.
CustomerGateways JSON string The list of queried customer gateways.
TotalCount Integer The number of queried entries.
PageNumber Integer The current page number.
PageSize Integer The number of entries on the current page.
CustomerGateway objects
Name Type Description
CustomerGatewayId String The ID of the customer gateway.
Name String The name of the customer gateway.
Description String The description of the customer gateway.
IpAddress String The IP address of the customer gateway.
CreateTime Long The creation time of the customer gateway.

Error codes

See VPC API Error Center.


Request example

  1. https://vpc.aliyuncs.com/?Action=DescribeCustomerGateways
  2. &RegionID=cn-beijing
  3. &<CommonParameters>

Response example

XML format

  1. <DescribeCustomerGatewaysResponse>
  2. <PageNumber>1</PageNumber>
  3. <TotalCount>3</TotalCount>
  4. <PageSize>10</PageSize>
  5. <RequestId>5BE01CD7-5A50-472D-AC14-CA181C5C03BE</RequestId>
  6. <CustomerGateways>
  7. <CustomerGateway>
  8. <Name>test</Name>
  9. <CustomerGatewayId>cgw-bp1pvpl9r9adju6l5nxck</CustomerGatewayId>
  10. <CreateTime>1492747187000</CreateTime>
  11. <IpAddress></IpAddress>
  12. </CustomerGateway>
  13. </CustomerGateways>
  14. </DescribeCustomerGatewaysResponse>

JSON format

  1. {
  2. "PageNumber": 1,
  3. "TotalCount": 3,
  4. "PageSize": 10,
  5. "RequestId": "E82612A9-CB90-4D7E-B394-1DB7F6509B29",
  6. "CustomerGateways": {
  7. "CustomerGateway": [
  8. {
  9. "Name": "test",
  10. "CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5nxck",
  11. "CreateTime": 1492747187000,
  12. "IpAddress": ""
  13. }
  14. ]
  15. }
  16. }
Thank you! We've received your feedback.